@accordkit/tracer - v0.2.1
    Preparing search index...

    Interface BrowserSinkOptions

    interface BrowserSinkOptions {
        endpoint?: string;
        headers?: Record<string, string>;
        beaconMaxBytes?: number;
        delivery?: BrowserDeliveryMode;
        onDropBatch?: (lines: string[], error?: unknown) => void;
        durable?: "none" | "idb";
        idbName?: string;
        idbStore?: string;
        idbVersion?: number;
        maxBuffer?: number;
        batchSize?: number;
        flushIntervalMs?: number;
        overflowPolicy?: OverflowPolicy;
    }

    Hierarchy (View Summary)

    Index

    Properties

    endpoint? headers? beaconMaxBytes? delivery? onDropBatch? durable? idbName? idbStore? idbVersion? maxBuffer? batchSize? flushIntervalMs? overflowPolicy?

    Properties

    endpoint?: string

    POST endpoint to deliver logs. If omitted, flushes are no-ops (buffer cleared).

    headers?: Record<string, string>

    Extra headers for fetch fallback (content-type defaults to application/json).

    beaconMaxBytes?: number

    Max payload size for sendBeacon (default: 60 KiB).

    delivery?: BrowserDeliveryMode

    Delivery mode: 'immediate' (send on write) or 'buffered' (periodic/explicit flush). Default: 'buffered'.

    onDropBatch?: (lines: string[], error?: unknown) => void

    Called when a batch is dropped (e.g., fetch fails in immediate mode).

    durable?: "none" | "idb"

    Durability: 'none' (default) | 'idb' for IndexedDB-backed queue.

    idbName?: string

    IndexedDB database name (when durable === 'idb'). Default: 'accordkit'

    idbStore?: string

    IndexedDB object store name (when durable === 'idb'). Default: 'events'

    idbVersion?: number

    IndexedDB version (when durable === 'idb'). Default: 1

    maxBuffer?: number

    The maximum total number of events to keep in memory across all session buffers. If the total exceeds this size, the oldest events from the largest buffer will be dropped. This prevents unbounded memory growth. Only applies to buffered delivery mode.

    5000
    batchSize?: number

    The number of events to collect in a session's buffer before triggering a flush. Only applies to buffered delivery mode.

    100
    flushIntervalMs?: number

    The maximum time in milliseconds to wait before flushing buffers, regardless of their size. Only applies to buffered delivery mode.

    1000
    overflowPolicy?: OverflowPolicy

    The policy to apply when the maxBuffer limit is reached. This determines how the sink behaves when it's under heavy load.

    • auto-flush: Immediately triggers a flush.
    • drop-oldest: Discards the oldest events to make room for new ones.
    • error: Throw on overflow (useful for tests).

    OverflowPolicy

    'auto-flush'

    Settings

    Member Visibility

    On This Page

    Properties