Skip to content

API reference > @kontsedal/olas-realtime > LiveStreamOptions

LiveStreamOptions type ​

Live-stream options. capacity is the maximum buffer length (oldest events are dropped); flushMs coalesces bursty writes into a single signal update.flushMs <= 0 flushes synchronously per event.

Signature:

typescript
export type LiveStreamOptions<TEvent = unknown> = {
  capacity?: number;
  flushMs?: number;
  rafFlush?: boolean;
  onDrop?: (dropped: readonly TEvent[]) => void;
};

Released under the MIT License.