listr2

Appearance

Documentation / listr2 / ListrLogger

Class: ListrLogger<Levels> ​

Defined in: packages/listr2/src/utils/logger/logger.ts:13

Creates a new Listr2 logger.

This logger is used throughout the renderers for consistency.

See ​

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

Type Parameters ​

Levels ​

Levels extends string = string

Constructors ​

Constructor ​

new ListrLogger<Levels>(options?): ListrLogger<Levels>

Defined in: packages/listr2/src/utils/logger/logger.ts:16

Parameters ​

options? ​

ListrLoggerOptions<Levels>

Returns ​

ListrLogger<Levels>

Properties ​

process ​

readonly process: ProcessOutput

Defined in: packages/listr2/src/utils/logger/logger.ts:14

options? ​

optional options: ListrLoggerOptions<Levels>

Defined in: packages/listr2/src/utils/logger/logger.ts:16

Methods ​

log() ​

log(level, message, options?): void

Defined in: packages/listr2/src/utils/logger/logger.ts:30

Parameters ​

level ​

Levels

message ​

string | any[]

options? ​

LoggerFieldOptions

Returns ​

void

toStdout() ​

toStdout(message, options?, eol?): void

Defined in: packages/listr2/src/utils/logger/logger.ts:42

Parameters ​

message ​

string | any[]

options? ​

LoggerFieldOptions

eol? ​

boolean = true

Returns ​

void

toStderr() ​

toStderr(message, options?, eol?): void

Defined in: packages/listr2/src/utils/logger/logger.ts:46

Parameters ​

message ​

string | any[]

options? ​

LoggerFieldOptions

eol? ​

boolean = true

Returns ​

void

wrap() ​

wrap(message, options?): string

Defined in: packages/listr2/src/utils/logger/logger.ts:50

Parameters ​

message ​

string

options? ​

LoggerFormatOptions

Returns ​

string

splat() ​

splat(...args): string

Defined in: packages/listr2/src/utils/logger/logger.ts:58

Parameters ​

args ​

...[string, ...splat: any[]]

Returns ​

string

suffix() ​

suffix(message, ...suffixes): string

Defined in: packages/listr2/src/utils/logger/logger.ts:64

Parameters ​

message ​

string

suffixes ​

...LoggerField[]

Returns ​

string

prefix() ​

prefix(message, ...prefixes): string

Defined in: packages/listr2/src/utils/logger/logger.ts:86

Parameters ​

message ​

string

prefixes ​

...LoggerField[]

Returns ​

string

fields() ​

fields(message, options?): string

Defined in: packages/listr2/src/utils/logger/logger.ts:109

Parameters ​

message ​

string

options? ​

LoggerFieldOptions<true>

Returns ​

string

icon() ​

icon(level, icon?): string

Defined in: packages/listr2/src/utils/logger/logger.ts:129

Parameters ​

level ​

Levels

icon? ​

string | false

Returns ​

string

format() ​

protected format(level, message, options?): string

Defined in: packages/listr2/src/utils/logger/logger.ts:150

Parameters ​

level ​

Levels

message ​

string | any[]

options? ​

LoggerFieldOptions

Returns ​

string

style() ​

protected style(level, message): string

Defined in: packages/listr2/src/utils/logger/logger.ts:174

Parameters ​

level ​

Levels

message ​

string

Returns ​

string

applyFormat() ​

protected applyFormat(message, options?): string

Defined in: packages/listr2/src/utils/logger/logger.ts:188

Parameters ​

message ​

string

options? ​

LoggerFormatOptions

Returns ​

string

spacing() ​

protected spacing(message): string

Defined in: packages/listr2/src/utils/logger/logger.ts:196

Parameters ​

message ​

string

Returns ​

string