Graphorin API reference v0.7.0

---

Graphorin API reference / @graphorin/server / / ReplayBuffer

Interface: ReplayBuffer

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

Per-subject replay buffer. Stores up to maxEvents per subject with a TTL; thread-safe under the single-writer Node event loop model.

Stable

Methods

forget()

forget(subject): void;

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

Parameters

Parameter	Type
subject	string

Returns

void

---

prune()

prune(): void;

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

Returns

void

---

push()

push(subject, event): void;

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

Parameters

Parameter	Type
subject	string
event	{ eventId: string; kind: "event"; payload?: unknown; subject: string; subscriptionId: string; type: string; v: "1"; }
event.eventId	string
event.kind	"event"
event.payload?	unknown
event.subject	string
event.subscriptionId	string
event.type	string
event.v	"1"

Returns

void

---

replay()

replay(subject, sinceEventId): ReplayBufferSlice;

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

Parameters

Parameter	Type
subject	string
sinceEventId	string | undefined

Returns

ReplayBufferSlice

---

size()

size(subject): number;

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

Parameters

Parameter	Type
subject	string

Returns

number

---

stats()?

optional stats(): ReplayBufferStats;

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

Occupancy snapshot (W-028). OPTIONAL so external implementations of this @stable interface keep compiling; createReplayBuffer always provides it. When absent, the /v1/metrics replay-buffer gauge degrades to 0.

Returns

ReplayBufferStats