listr2

Appearance

Verbose Renderer ​

VerboseRenderer is the default non-TTY renderer and works mostly like a logger.

demo

Renderer Options ​

Details

Documentation / listr2 / ListrVerboseRendererOptions

Interface: ListrVerboseRendererOptions ​

Defined in: packages/listr2/src/renderer/verbose/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

logTitleChange? ​

optional logTitleChange: boolean

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

Log the title changes of the task.

Default ​

false

pausedTimer? ​

optional pausedTimer: PresetTimer

Defined in: packages/listr2/src/renderer/verbose/renderer.interface.ts:20

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 / ListrVerboseRendererTaskOptions

Interface: ListrVerboseRendererTaskOptions ​

Defined in: packages/listr2/src/renderer/verbose/renderer.interface.ts:23

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