Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/server / ws / scheduleReplayBufferPruning

Function: scheduleReplayBufferPruning()

ts
function scheduleReplayBufferPruning(buffer, opts?): () => void;

Defined in: packages/server/src/ws/replay-buffer.ts:197

W-028: schedule a periodic ReplayBuffer.prune sweep. Without it TTL expiry only ran lazily inside push/replay/size FOR THE SAME SUBJECT, so every finished run-subject (a fresh runId per run) retained up to maxEvents full payloads forever on a long-living server. Mirrors scheduleRunPruning (IP-16): unref-ed timer, returns a stop function. The sweep applies only the already documented TTL - replay semantics inside the TTL window are unchanged (an immediate forget on run completion would break short-disconnect resume of terminal events).

Parameters

ParameterType
bufferReplayBuffer
opts{ intervalMs?: number; }
opts.intervalMs?number

Returns

() => void

Stable