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.
Methods
Section titled “Methods”ack(
id):Promise<void>
Defined in: packages/core/src/spool.ts:13
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
drop()?
Section titled “drop()?”
optionaldrop(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.
Parameters
Section titled “Parameters”(event) => boolean
Returns
Section titled “Returns”Promise<number>
next()
Section titled “next()”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.
Returns
Section titled “Returns”Promise<{ events: WireEvent[]; id: string; } | undefined>
write()
Section titled “write()”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).
Parameters
Section titled “Parameters”events
Section titled “events”readonly WireEvent[]
Returns
Section titled “Returns”Promise<boolean>