Skip to content

Documentation / listr2 / ListrLoggerOptions

Interface: ListrLoggerOptions<Levels>

Options for the logger

Extends

Type parameters

Levels extends string

Properties

useIcons?

optional useIcons: boolean

Use icons for the log levels.

Source

packages/listr2/src/utils/logger/logger.interface.ts:11


fields?

optional fields: LoggerFieldOptions<true>

Apply fields and templates as presets before and after each message.

Source

packages/listr2/src/utils/logger/logger.interface.ts:15


toStderr?

optional toStderr: (string | Levels)[]

Send the designated levels to process.stderr.

Source

packages/listr2/src/utils/logger/logger.interface.ts:19


color?

optional color: Partial<Record<string | Levels, LoggerFormat>>

Coloring of the levels.

See

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

Inherited from

ListrLoggerStyleMap.color

Source

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


icon?

optional icon: Partial<Record<string | Levels, string>>

Icons of the levels.

See

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

Inherited from

ListrLoggerStyleMap.icon

Source

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


processOutput?

optional processOutput: ProcessOutput

Pass your implementation of process output class to write to stdout and stderr.

Default

ts
'ProcessOutput'

Global

global option that can not be temperated with subtasks

Inherited from

ProcessOutputRendererOptions.processOutput

Source

packages/listr2/src/utils/process-output/process-output.interface.ts:11