Destination for a scrolling heatmap column.
interface ColumnSink| appendColumn | (values: ArrayLike<number>) => void |
Decode a binary frame. Throws if magic/version is unknown.
(buffer: ArrayBuffer) => StreamFrameDecode a binary frame off the UI thread when a `Worker` is available — a real `postMessage` round trip, not a same-thread wrapper. The input buffer is copied before transfer, so the caller keeps ownership (same contract as {@link decodeFrame}). Falls back to synchronous decode in environments without `Worker`/`Blob` (e.g. Node, SSR).
(buffer: ArrayBuffer) => Promise<StreamFrame>Decode a JSON frame produced by {@link encodeJsonFrame}.
(text: string) => StreamFrame(x: Float64Array, y: Float64Array, target: number) => Promise<{ x: Float64Array; y: Float64Array; }>type DropPolicy = DropPolicyEncode a batch without JSON.
(frame: StreamFrame, options?: EncodeFrameOptions) => ArrayBufferinterface EncodeFrameOptions| dtype? | StreamDtype | undefined |
Optional slow-path JSON frame (not for the hot ingest loop).
(frame: StreamFrame) => string32Bounded frame queue. Pause + burst ingest cannot grow without limit.
class FrameQueueinterface FrameQueueOptions| maxQueue? | number | undefined |
| drop? | DropPolicy | undefined |
| maxHz? | number | undefined |
(value: unknown) => value is { op: string; }WebTransport research spike (Phase 5). Rekhly's production ingest path is WebSocket (binary FLXB) + SSE (JSON). WebTransport is detected when present so a later milestone can swap the byte transport without changing {@link decodeFrame }.
() => boolean1interface QueueStats| received | number |
| dropped | number |
| applied | number |
| queued | number |
Fixed-capacity XY ring. Oldest samples are overwritten. `readInto` copies into caller-owned arrays so a streaming series can reuse pooled storage instead of allocating every append.
class RingBufferDestination for a decoded XY batch. Charts/series implement this.
interface SampleSink| appendSamples | (data: { readonly x: ArrayLike<number>; readonly y: ArrayLike<number>; }) => void |
Server-Sent Events helper (JSON batches only).
class SseClientWebSocket client. Binary frames are preferred; JSON is the slow path. Control ops (subscribe / pause / frequency) are small JSON messages and are not on the sample hot path.
class StreamClientinterface StreamClientOptions| url | string |
| socket? | Pick<WebSocket, "send" | "close" | "addEventListener" | "removeEventListener" | "readyState"> | undefined |
| onFrame? | ((frame: StreamFrame) => void) | undefined |
| onError? | ((error: unknown) => void) | undefined |
type StreamDtype = StreamDtypeinterface StreamFrame| version | number |
| streamId | number |
| seriesId | number |
| timestamp | number |
| x | Float64Array<ArrayBufferLike> |
| y | Float64Array<ArrayBufferLike> |
type StreamOp = StreamOpPause/resume + backpressure in front of one or more sinks. Bind `seriesId` → {@link SampleSink}. Incoming frames are queued and flushed on {@link StreamSession.flush} (typically once per animation frame).
class StreamSessioninterface StreamSessionOptions| drop? | DropPolicy | undefined |
| maxQueue? | number | undefined |
| maxHz? | number | undefined |
Feature-detect only. Construction throws unless the runtime has `WebTransport`. No datagrams are sent — this is the documented spike.
class WebTransportSpikeinterface WebTransportSpikeOptions| url | string |
Got any questions? I'm happy to help with products, licensing, and examples.