magiclogger - v0.1.0
    Preparing search index...

    Interface StreamTransportOptions

    Stream transport options for Node.js streams.

    interface StreamTransportOptions {
        autoClose?: boolean;
        enabled?: boolean;
        encoding?: BufferEncoding;
        excludeTags?: string[];
        filter?: (entry: LogEntry) => boolean;
        format?: "json" | "plain" | "custom";
        formatter?: (entry: LogEntry) => string | Buffer<ArrayBufferLike>;
        level?: string;
        levels?: string[];
        maxQueueSize?: number;
        name?: string;
        silent?: boolean;
        stream: WritableStream;
        tags?: string[];
        timeout?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoClose? enabled? encoding? excludeTags? filter? format? formatter? level? levels? maxQueueSize? name? silent? stream tags? timeout?

    Properties

    autoClose?: boolean

    Whether to close the stream when transport is closed.

    false
    enabled?: boolean

    Whether this transport is currently active. Allows runtime enabling/disabling of transports.

    true
    encoding?: BufferEncoding

    Stream encoding.

    'utf8'
    excludeTags?: string[]

    Tags that exclude logs from this transport. Logs with any of these tags are skipped.

    filter?: (entry: LogEntry) => boolean

    Custom filter function for advanced filtering logic. Return true to process the log, false to skip.

    format?: "json" | "plain" | "custom"

    Output format for this transport.

    'json'
    formatter?: (entry: LogEntry) => string | Buffer<ArrayBufferLike>

    Custom formatter function. Used when format is 'custom'.

    level?: string

    Minimum log level this transport will handle. Logs below this level are ignored by this transport.

    'info'
    levels?: string[]

    Custom levels this transport should handle. Allows fine-grained control over what gets logged where.

    maxQueueSize?: number

    Maximum internal queue size before dropping/handling backpressure. Defaults to 1000 if not provided.

    name?: string

    Unique name identifier for this transport instance. Used for managing multiple transports.

    silent?: boolean

    Whether to handle errors silently or propagate them.

    true
    stream: WritableStream

    Target writable stream.

    tags?: string[]

    Tags that must be present for this transport to handle a log. If specified, only logs with at least one matching tag are processed.

    timeout?: number

    Timeout for transport operations in milliseconds.

    30000 (30 seconds)

    Settings

    Member Visibility

    On This Page

    Properties