Documentation / listr2 / ListrDefaultRendererTaskOptions

Interface: ListrDefaultRendererTaskOptions

Defined in: packages/listr2/src/renderer/default/renderer.interface.ts:151

Extends

• RendererPresetTimer

Properties

timer?

optional timer?: PresetTimer

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

Show duration for the tasks.

Inherited from

RendererPresetTimer.timer

---

outputBar?

optional outputBar?: number | boolean

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

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

---

bottomBar?

optional bottomBar?: number | boolean

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

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

---

persistentOutput?

optional persistentOutput?: boolean

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

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

false