SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface LogChannels

    The variadic output channels handed to a script or snippet as log / warn / error.

    Deliberately NOT an ILogger: this is the agent-facing surface, so it takes a console-style argument list rather than (message, options). Anything an author would reasonably pass renders - strings, values, and SDK objects (a range, a stats report) via the injected LogRenderer.

    interface LogChannels {
        error(...args: any[]): void;
        flush(options?: { timeoutMs?: number }): Promise<void>;
        log(...args: any[]): void;
        warn(...args: any[]): void;
    }
    Index
    • Diagnostics: something wrong.

      Parameters

      • ...args: any[]

      Returns void

    • Resolves once every queued entry has reached the backing logger.

      Parameters

      • Optionaloptions: { timeoutMs?: number }

      Returns Promise<void>

      Rendering an SDK object is async, so a log(range) may still be in flight when the script returns. The runtime awaits this before reporting the run, which is what guarantees the log is complete (and correctly ordered) by the time a caller reads it.

      With timeoutMs, a value still unsettled when it elapses prints as [pending] and a single warn says how many did. Only that value is given up: the rest of its line, and every line queued behind it, is still written in order. Without it (or with 0), flush waits as long as the slowest logged promise - forever for one that never settles.

    • The reporting channel - findings and results.

      Parameters

      • ...args: any[]

      Returns void

    • Diagnostics: something surprising but survivable.

      Parameters

      • ...args: any[]

      Returns void