Class BrowserSink

BrowserSink Buffered (or immediate) delivery of JSONL batches to an HTTP endpoint from the browser.

Uses navigator.sendBeacon for small payloads (≤ beaconMaxBytes), else falls back to fetch(keepalive).
Guarded flushes: no overlap; close() drains deterministically.
Optional durable storage via IndexedDB (survives reloads/crashes). When enabled:
- flush() moves RAM buffers -> IDB, then dequeues from IDB in batchSize chunks.
- chunks are deleted from IDB only after successful delivery.
- failures leave data in IDB for next flush (no data loss).

Implements

BufferedSink

Index

Constructors

Methods

write flush close

Constructors

constructor

new BrowserSink(opts?: BrowserSinkOptions): BrowserSink
Parameters
- Optionalopts: BrowserSinkOptions
Returns BrowserSink
- Defined in core/sinks/browserSink.ts:74

Methods

write

write(sessionId: string, e: TracerEvent): void | Promise<void>
Persist a single event for a session.
Parameters
- sessionId: string
  Unique identifier for grouping related events. Used for partitioning and log file naming.
- e: TracerEvent
  The trace event to persist. See TracerEvent for structure.
Returns void | Promise<void>
Void or Promise for async implementations.
Remarks
Implementations should:
- Handle errors gracefully without throwing
- Consider batching for performance if needed
- Maintain order of events within a session
- Be thread-safe if used in concurrent environments
Implementation of BufferedSink.write
- Defined in core/sinks/browserSink.ts:104

flush

flush(): Promise<void>
Public flush: serialized, drains RAM buffers (-> IDB if enabled) then IDB in batchSize chunks with sendBeacon/fetch.

Returns Promise<void>
Implementation of BufferedSink.flush
- Defined in core/sinks/browserSink.ts:150

close

close(): Promise<void>
Deterministic shutdown, idempotent, clears timers and handlers, drains fully.

Returns Promise<void>
Implementation of BufferedSink.close
- Defined in core/sinks/browserSink.ts:209