listr2

Appearance

Documentation / listr2 / ListrDefaultRendererTaskOptions

Interface: ListrDefaultRendererTaskOptions ​

Extends ​

Properties ​

timer? ​

optional timer: PresetTimer

Show duration for the tasks.

Inherited from ​

RendererPresetTimer.timer

Defined in ​

packages/listr2/src/presets/timer/preset.interface.ts:9

outputBar? ​

optional outputBar: number | boolean

Write task output to the output bar under the title.

  • true only keep the last line.
  • Infinity will keep all the lines.
  • number will keep the defined amount of lines.
  • false will not render output with this method.

Default Value ​

true

Defined in ​

packages/listr2/src/renderer/default/renderer.interface.ts:162

bottomBar? ​

optional bottomBar: number | boolean

Write task output to the bottom bar instead of the gap under the task title itself. This can be useful for stream of data coming in and is the default mode for tasks without a title.

This will take precedence over the outputBar option, if explicitly set.

  • true only keep the last line.
  • Infinity will keep all the lines.
  • number will keep the defined amount of lines.
  • false will not render output with this method.

Default Value ​

false

Defined in ​

packages/listr2/src/renderer/default/renderer.interface.ts:176

persistentOutput? ​

optional persistentOutput: boolean

Keep output of the task after task finishes.

  • This can be enabled for both normal task output under the title and bottom bar.

Default Value ​

ts
false

Defined in ​

packages/listr2/src/renderer/default/renderer.interface.ts:184