listr2

Appearance

Documentation / listr2 / ListrLoggerOptions

Interface: ListrLoggerOptions<Levels> ​

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

Options for the logger

Extends ​

Type Parameters ​

Levels ​

Levels extends string

Properties ​

useIcons? ​

optional useIcons: boolean

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

Use icons for the log levels.

fields? ​

optional fields: LoggerFieldOptions<true>

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

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

toStderr? ​

optional toStderr: (string | Levels)[]

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

Send the designated levels to process.stderr.

color? ​

optional color: Partial<Record<string | Levels, 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<string | Levels, 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

processOutput? ​

optional processOutput: ProcessOutput

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

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