splat-transform API Reference - v2.0.5
    Preparing search index...

    Interface TextRendererOptions

    Output streams and optional memory-usage probe for TextRenderer.

    interface TextRendererOptions {
        getLiveMemory?: () => number;
        getPeakMemory?: () => number;
        output?: (chunk: string) => void;
        write: (chunk: string) => void;
    }
    Index

    Properties

    getLiveMemory?: () => number

    Optional currently-live memory probe in bytes. When supplied alongside getPeakMemory, the --mem overlay becomes [peak X | live Y], where live reflects memory that V8 still tracks as alive. Unlike peak (kernel max RSS, monotonic), this value drops when the GC reclaims unreferenced allocations, so the gap between consecutive phases reveals whether each phase actually releases its scratch buffers. In Node this is typically heapUsed + external from process.memoryUsage() so ArrayBuffer storage (typed arrays) is included.

    getPeakMemory?: () => number

    Optional peak-memory probe in bytes. Used by the [peak X] overlay gated by the renderer's mem field. In Node this is typically derived from process.resourceUsage().maxRSS (which is kernel-tracked and reflects the whole process - including ArrayBuffers - rather than just the V8 heap).

    output?: (chunk: string) => void

    Receives output events, one logical unit per call, each already terminated with \n by the renderer. Hand this to the pipeable channel (typically process.stdout.write.bind(process.stdout)). Defaults to the same sink as write when omitted.

    write: (chunk: string) => void

    Receives all status chunks (scopes, bars, messages). May contain partial-line writes (e.g. progress-bar # ticks). For TTY output, hand this to a stream that flushes on partials (process.stderr.write.bind(process.stderr) in Node) so bars render in place. For non-interactive output (CI logs, file redirects), wrap in a line buffer that holds chunks until a \n arrives - the bar's incremental writes then coalesce into a single complete line per bar.