magiclogger - v0.1.0
    Preparing search index...

    Interface Transport

    Core transport interface that all transports must implement.

    interface Transport {
        enabled: boolean;
        name: string;
        close(): void | Promise<void>;
        disable?(): void;
        emit?(event: keyof TransportEvents, ...args: unknown[]): boolean;
        enable?(): void;
        flush?(): void | Promise<void>;
        getName?(): string;
        getStats?(): TransportStats;
        init?(): void | Promise<void>;
        isEnabled?(): boolean;
        isHealthy?(): Promise<boolean>;
        log(entry: LogEntry): void | Promise<void>;
        logBatch?(entries: LogEntry[]): void | Promise<void>;
        off?(
            event: keyof TransportEvents,
            listener: (...args: unknown[]) => void,
        ): this;
        on?(
            event: keyof TransportEvents,
            listener: (...args: unknown[]) => void,
        ): this;
        once?(
            event: keyof TransportEvents,
            listener: (...args: unknown[]) => void,
        ): this;
        removeListener?(
            event: keyof TransportEvents,
            listener: (...args: unknown[]) => void,
        ): this;
        resetStats?(): void;
        shouldLog(entry: LogEntry): boolean;
        supportsBatching?(): boolean;
    }
    Index

    Properties

    enabled name

    Methods

    close disable? emit? enable? flush? getName? getStats? init? isEnabled? isHealthy? log logBatch? off? on? once? removeListener? resetStats? shouldLog supportsBatching?

    Properties

    enabled: boolean

    Whether this transport is currently enabled.

    name: string

    Unique name of this transport instance.

    Methods

    • Close the transport and clean up resources. Should flush any pending logs.

      Returns void | Promise<void>

    • Flush any buffered logs immediately.

      Returns void | Promise<void>

    • Get the transport name. Matches class Transport API for structural typing.

      Returns string

    • Initialize the transport. Called when transport is added to logger.

      Returns void | Promise<void>

    • Check if transport is currently enabled. Matches class Transport API for structural typing.

      Returns boolean

    • Optional health check method.

      Returns Promise<boolean>

    • Log a single entry. Should handle the entry according to transport's configuration.

      Parameters

      Returns void | Promise<void>

    • Optional event helpers common on Node.js EventEmitter

      Parameters

      Returns this

    • Reset transport statistics (optional, but used by manager when available).

      Returns void

    • Whether this transport supports batching (optional).

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods