Interface LoggerOptions<Level, Meta>

interface LoggerOptions<Level, Meta> {
    filters?: Filter<Level, Meta>[];
    label?: string;
    level?: Level;
    levels: Level[];
    meta?: Meta;
    muted?: boolean;
    transforms?: Transform<Level, Meta>[];
    transports?: Transport<TransportOptions>[];
}

Type Parameters

  • Level extends string
  • Meta extends Record<string, unknown> = undefined

Hierarchy

Properties

filters? label? level? levels meta? muted? transforms? transports?

Properties

Optional filters

filters?: Filter<Level, Meta>[]

Array of Filters the payload must pass in order to be dispatched.

Default

[]

Optional label

label?: string

The label for the logger. If not provided a random id will be generated.

Default

undefined

Optional level

level?: Level

The initial level to be set for the logger.

Default

undefined

Readonly levels

levels: Level[]

The Logger's log levels. Once a Logger has been initialized these CANNOT be changed nor can a child change it's log levels.

Default

[]

Optional meta

meta?: Meta

Default metadata that should be included in each log event.

Default

undefined

Optional muted

muted?: boolean

Whether or not Logger or Transform is muted.

Optional transforms

transforms?: Transform<Level, Meta>[]

Array of Transforms to be run when dispatching through transform.

Default

[]

Optional transports

transports?: Transport<TransportOptions>[]

The Transport instances that this Logger should dispatch to.

Default

[]

Settings

Member Visibility

Theme

On This Page

filterslabellevellevelsmetamutedtransformstransports