Rulvar API reference / @rulvar/rulvar / ProgressHandle
Interface: ProgressHandle
Defined in: packages/rulvar/src/live-progress.ts:69
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
done | readonly | Promise<void> | Settles after the final frame is written; never rejects. | packages/rulvar/src/live-progress.ts:73 |
mode | readonly | "tty" | "lines" | "off" | The resolved mode after auto detection. | packages/rulvar/src/live-progress.ts:71 |
Methods
render()
ts
render(): void;Defined in: packages/rulvar/src/live-progress.ts:75
Force an immediate repaint outside the tick (tests, custom pacing).
Returns
void
stop()
ts
stop(final?): void;Defined in: packages/rulvar/src/live-progress.ts:81
Idempotent. final=true (default) paints the settle frame; false freezes the current frame in scrollback. Always restores the cursor and resolves done.
Parameters
| Parameter | Type |
|---|---|
final? | boolean |
Returns
void