Documentation / listr2 / LoggerFieldFn

Interface: LoggerFieldFn<Args>

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

Type Parameters

Args

Args extends any[] = any[]

Properties

field

field: string | (...args) => string

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

The value of the given field.

---

condition?

optional condition: boolean | (...args) => boolean

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

Condition to display the given field.

---

format()?

optional format: (...args) => LoggerFormat

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

Formatting/coloring of the field.

Parameters

args

...Args

Returns

LoggerFormat

---

args?

optional args: Args

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

Args to pass to other functions whenever this field is triggered.