Interface PayloadBase<Level>

interface PayloadBase<Level> {
    [CHAR]: number;
    [FILENAME]: string;
    [FILEPATH]: string;
    [ID]: string;
    [LEVELINT]: number;
    [LEVEL]: Level;
    [LINE]: number;
    [LOGGER]: string;
    [MESSAGE]: string | Error;
    [METHOD]: string;
    [SPLAT]: any[];
    [TIMESTAMP]: string | number | Date;
    [TRANSPORT]?: string;
    message: string;
    [key: string]: any;
}

Type Parameters

  • Level extends string

Indexable

[key: string]: any

Optional paylod key/values.

Properties

[CHAR]: number

The log message's character position.

[FILENAME]: string

The log message's filename.

[FILEPATH]: string

The log message's filepath.

[ID]: string

The payload's log id.

[LEVELINT]: number

The log level integer.

[LEVEL]: Level

The payload's log level.

[LINE]: number

The log message's line position.

[LOGGER]: string

The payload's Logger label.

[MESSAGE]: string | Error

The payload's message.

[METHOD]: string

The log message's target method.

[SPLAT]: any[]

Array containing payload arguments beyond the primary message.

[TIMESTAMP]: string | number | Date

The payload's log id.

[TRANSPORT]?: string

The payload's Transport label.

message: string

Primary log payload message.