RTCForge API Reference v1.1.1
    Preparing search index...

    Structured logging interface accepted throughout RTCForge.

    Every method takes a message and an optional structured context object. Implementations decide how to serialize and route the output. Supply noopLogger to disable logging.

    interface Logger {
        debug(msg: string, ctx?: Record<string, unknown>): void;
        error(msg: string, ctx?: Record<string, unknown>): void;
        fatal(msg: string, ctx?: Record<string, unknown>): void;
        info(msg: string, ctx?: Record<string, unknown>): void;
        warn(msg: string, ctx?: Record<string, unknown>): void;
    }
    Index

    Methods

    • Logs a fine-grained diagnostic message useful during development.

      Parameters

      • msg: string

        The log message.

      • Optionalctx: Record<string, unknown>

        Optional structured context to attach to the entry.

      Returns void

    • Logs an error that occurred but did not necessarily halt operation.

      Parameters

      • msg: string

        The log message.

      • Optionalctx: Record<string, unknown>

        Optional structured context to attach to the entry.

      Returns void

    • Logs a fatal condition, typically preceding process termination.

      Parameters

      • msg: string

        The log message.

      • Optionalctx: Record<string, unknown>

        Optional structured context to attach to the entry.

      Returns void

    • Logs an informational message about normal operation.

      Parameters

      • msg: string

        The log message.

      • Optionalctx: Record<string, unknown>

        Optional structured context to attach to the entry.

      Returns void

    • Logs a warning about a recoverable or unexpected condition.

      Parameters

      • msg: string

        The log message.

      • Optionalctx: Record<string, unknown>

        Optional structured context to attach to the entry.

      Returns void