Interface FileTransportOptions<Level, Label>

interface FileTransportOptions<Level, Label> {
    asJSON?: boolean;
    audit_file?: string;
    date_format?: string;
    end_stream?: boolean;
    eol?: string;
    file_options?: FileOptions;
    filename?: string;
    filters?: Filter<Level, undefined>[];
    frequency?: Frequency;
    highWaterMark?: number;
    label: Label;
    level?: Level;
    max_logs?: string;
    muted?: boolean;
    size?: string;
    transforms?: Transform<Level, undefined>[];
    verbose?: boolean;
    onNew?(newFile?): void;
    onRotate?(oldFile?, newFile?): void;
}

Type Parameters

  • Level extends string
  • Label extends string = string

Hierarchy (view full)

Properties

asJSON? audit_file? date_format? end_stream? eol? file_options? filename? filters? frequency? highWaterMark? label level? max_logs? muted? size? transforms? verbose?

Methods

onNew? onRotate?

Properties

Optional asJSON

asJSON?: boolean

Kricket on final dispatch can output JSON or the payload message. When "asJSON" is set to false the payload contains only the message.

Default

true

Optional audit_file

audit_file?: string

Optional date_format

date_format?: string

Optional end_stream

end_stream?: boolean

Optional eol

eol?: string

Optional file_options

file_options?: FileOptions

Optional filename

filename?: string

Optional filters

filters?: Filter<Level, undefined>[]

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

Default

[]

Optional frequency

frequency?: Frequency

Optional highWaterMark

highWaterMark?: number

The stream limit which when reached we should pause writes until backpressure has been relieved.

Default

16

label

label: Label

The name/label for the Transport.

Optional level

level?: Level

The log Level that has been assigned.

Optional max_logs

max_logs?: string

Optional muted

muted?: boolean

Whether or not Logger or Transform is muted.

Optional size

size?: string

Optional transforms

transforms?: Transform<Level, undefined>[]

Array of Transforms to be run when dispatching through transform.

Default

[]

Optional verbose

verbose?: boolean

Methods

Optional onNew

Optional onRotate

  • onRotate(oldFile?, newFile?): void

  • Parameters

    • Optional oldFile: string
    • Optional newFile: string

    Returns void

Settings

Member Visibility

Theme

On This Page

asJSONaudit_filedate_formatend_streameolfile_optionsfilenamefiltersfrequencyhighWaterMarklabellevelmax_logsmutedsizetransformsverboseonNewonRotate