Skip to content

EventSpool

Defined in: packages/core/src/spool.ts:8

Durable overflow storage for long collector outages. The client writes batches when memory fills up and on shutdown(), replays the oldest first, and acknowledges a batch only once the collector accepted it. Batches never contain raw user IDs. Implementations may throw; the client catches and counts every failure.

ack(id): Promise<void>

Defined in: packages/core/src/spool.ts:13

string

Promise<void>


optional drop(match): Promise<number>

Defined in: packages/core/src/spool.ts:18

Removes the stored events match accepts, such as those of a user who asked for erasure, and resolves to how many. Optional: without it, an erasure doesn’t reach events already on disk.

(event) => boolean

Promise<number>


next(): Promise<{ events: WireEvent[]; id: string; } | undefined>

Defined in: packages/core/src/spool.ts:12

The oldest stored batch, or undefined when the spool is empty.

Promise<{ events: WireEvent[]; id: string; } | undefined>


write(events): Promise<boolean>

Defined in: packages/core/src/spool.ts:10

Persists a batch. Resolves false when it can’t be stored (for example the size cap is reached).

readonly WireEvent[]

Promise<boolean>