Rulvar API reference / @rulvar/rulvar / ProgressOptions
Interface: ProgressOptions
Defined in: packages/rulvar/src/live-progress.ts:47
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
clock? | ProgressClock | Defaults to a monotonic clock (performance.now) plus setInterval. | packages/rulvar/src/live-progress.ts:51 |
color? | boolean | SGR colors. Default: true in tty mode unless NO_COLOR is set. | packages/rulvar/src/live-progress.ts:60 |
fps? | number | Repaints per second in tty mode, clamped to 1..30. Default 10. | packages/rulvar/src/live-progress.ts:58 |
maxRows? | number | Body rows before the oldest completed rows collapse. Default 24. | packages/rulvar/src/live-progress.ts:64 |
mode? | ProgressMode | 'auto' (default) picks 'tty' when the sink reports a TTY and the environment is not CI or TERM=dumb, else 'lines'. | packages/rulvar/src/live-progress.ts:56 |
sink? | ProgressSink | Defaults to process.stderr so application stdout stays clean. | packages/rulvar/src/live-progress.ts:49 |
title? | string | Header title. Default: the workflow name from run:start. | packages/rulvar/src/live-progress.ts:66 |
width? | number | Column override. Default sink.columns, else 80. | packages/rulvar/src/live-progress.ts:62 |