listr2

Appearance

Simple Renderer ​

SimpleRenderer is an alternative to DefaultRenderer, which does not directly update the terminal but works more in a logger-like manner.

SimpleRenderer still requires vt100 terminal compatibility if you are using prompts, but can work in non-TTY environments other than that.

demo

Renderer Options ​

Details

Documentation / listr2 / ListrSimpleRendererOptions

Interface: ListrSimpleRendererOptions ​

Defined in: packages/listr2/src/renderer/simple/renderer.interface.ts:8

Inject your custom style map consisting of icons and coloring for the ListrLogger.

See ​

https://listr2.kilic.dev/renderer/logger.html

Extends ​

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

timestamp? ​

optional timestamp: PresetTimestamp

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

Show timestamp for each event that has been logged.

Inherited from ​

RendererPresetTimestamp.timestamp

pausedTimer? ​

optional pausedTimer: PresetTimer

Defined in: packages/listr2/src/renderer/simple/renderer.interface.ts:14

Show duration for the pauses.

Default Value ​

PRESET_TIMER

color? ​

optional color: Partial<Record<ListrLogLevels, LoggerFormat>>

Defined in: packages/listr2/src/utils/logger/logger.interface.ts:33

Coloring of the levels.

See ​

https://listr2.kilic.dev/renderer/logger.html#style

Inherited from ​

ListrLoggerStyleMap.color

icon? ​

optional icon: Partial<Record<ListrLogLevels, string | () => string>>

Defined in: packages/listr2/src/utils/logger/logger.interface.ts:39

Icons of the levels.

See ​

https://listr2.kilic.dev/renderer/logger.html#style

Inherited from ​

ListrLoggerStyleMap.icon

logger? ​

optional logger: ListrLogger<ListrLogLevels>

Defined in: packages/listr2/src/utils/logger/logger.interface.ts:82

Inject your custom implementation of the ListrLogger.

See ​

https://listr2.kilic.dev/renderer/logger.html

Inherited from ​

RendererLoggerOptions.logger

Renderer Task Options ​

Details

Documentation / listr2 / ListrSimpleRendererTaskOptions

Interface: ListrSimpleRendererTaskOptions ​

Defined in: packages/listr2/src/renderer/simple/renderer.interface.ts:17

Extends ​

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