magiclogger - v0.1.0
    Preparing search index...

    Interface AsyncLoggerOptions

    Configuration options for the AsyncLogger.

    AsyncLoggerOptions

    1.0.0

    interface AsyncLoggerOptions {
        buffer?: { flushInterval?: number; size?: number };
        enableMetrics?: boolean;
        id?: string;
        onFlush?: (entries: LogEntry[]) => void | Promise<void>;
        transports?: Transport[];
        useColors?: boolean;
        useConsole?: boolean;
        useRingBuffer?: boolean;
        useWorkers?: boolean;
        worker?: {
            batchSize?: number;
            batchTimeout?: number;
            enabled?: boolean;
            flushInterval?: number;
            poolSize?: number;
            useRingBuffer?: boolean;
        };
    }
    Index

    Properties

    buffer? enableMetrics? id? onFlush? transports? useColors? useConsole? useRingBuffer? useWorkers? worker?

    Properties

    buffer?: { flushInterval?: number; size?: number }

    Buffer configuration (for backward compatibility with tests)

    Type Declaration

    • OptionalflushInterval?: number

      Flush interval in ms

    • Optionalsize?: number

      Buffer size/capacity

    enableMetrics?: boolean

    Enable performance metrics collection

    id?: string

    Unique identifier for this logger instance

    onFlush?: (entries: LogEntry[]) => void | Promise<void>

    Callback when logs are flushed

    transports?: Transport[]

    Array of transports to use for output

    useColors?: boolean

    Whether to enable color/style support (default: true)

    useConsole?: boolean

    Whether to use console transport by default (default: true)

    useRingBuffer?: boolean

    Use high-performance ring buffer transport (default: false)

    useWorkers?: boolean

    Enable worker threads for processing (default: false)

    worker?: {
        batchSize?: number;
        batchTimeout?: number;
        enabled?: boolean;
        flushInterval?: number;
        poolSize?: number;
        useRingBuffer?: boolean;
    }

    Worker thread configuration

    Type Declaration

    • OptionalbatchSize?: number

      Compatibility: batch size

    • OptionalbatchTimeout?: number

      Compatibility: batch timeout

    • Optionalenabled?: boolean

      Enable worker threads (default: false for better performance)

    • OptionalflushInterval?: number

      Periodic flush interval in ms (default: 50)

    • OptionalpoolSize?: number

      Number of worker threads (default: 1)

    • OptionaluseRingBuffer?: boolean

      Use high-performance ring buffer transport (default: true when workers enabled)

    Settings

    Member Visibility

    On This Page

    Properties