Interface StreamTransportOptions<Level, Label>

interface StreamTransportOptions<Level, Label> {
    asJSON?: boolean;
    filters?: Filter<Level, undefined>[];
    highWaterMark?: number;
    label: Label;
    level?: Level;
    muted?: boolean;
    stream: Writable;
    transforms?: Transform<Level, undefined>[];
}

Type Parameters

  • Level extends string
  • Label extends string = string

Hierarchy (view full)

Properties

asJSON? filters? highWaterMark? label level? muted? stream transforms?

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 filters

filters?: Filter<Level, undefined>[]

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

Default

[]

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 muted

muted?: boolean

Whether or not Logger or Transform is muted.

stream

stream: Writable

Optional transforms

transforms?: Transform<Level, undefined>[]

Array of Transforms to be run when dispatching through transform.

Default

[]

Settings

Member Visibility

Theme

On This Page

asJSONfiltershighWaterMarklabellevelmutedstreamtransforms