EventLaneRuntime
Defined in: packages/client/src/event-lane.ts:185
Properties
Section titled “Properties”abortInFlight
Section titled “abortInFlight”abortInFlight: () =>
void
Defined in: packages/client/src/event-lane.ts:198
Abort any in-flight flush request (the teardown seam, mirroring the mutation runtime’s).
Returns
Section titled “Returns”void
appendEvent
Section titled “appendEvent”appendEvent: (
stream,payload) =>Promise<EventAppendResult>
Defined in: packages/client/src/event-lane.ts:188
Parameters
Section titled “Parameters”stream
Section titled “stream”string
payload
Section titled “payload”unknown
Returns
Section titled “Returns”Promise<EventAppendResult>
flush: () =>
Promise<void>
Defined in: packages/client/src/event-lane.ts:190
Drain the Outbox: assemble, POST and settle batches until nothing more is eligible this pass.
Returns
Section titled “Returns”Promise<void>
hasStreams
Section titled “hasStreams”
readonlyhasStreams:boolean
Defined in: packages/client/src/event-lane.ts:187
Whether the registry registered any Event stream. False → appendEvent throws and no driver is stood up.
onEventLaneReport
Section titled “onEventLaneReport”onEventLaneReport: (
listener) => () =>void
Defined in: packages/client/src/event-lane.ts:196
Subscribe to per-flush reports. Ephemeral (nothing is retained); returns an unsubscribe.
Parameters
Section titled “Parameters”listener
Section titled “listener”(report) => void
Returns
Section titled “Returns”() => void
onOutboxStatus
Section titled “onOutboxStatus”onOutboxStatus: (
listener) => () =>void
Defined in: packages/client/src/event-lane.ts:194
Subscribe to the drain signal; the CURRENT state is delivered on subscribe. Returns an unsubscribe.
Parameters
Section titled “Parameters”listener
Section titled “listener”(status) => void
Returns
Section titled “Returns”() => void
outboxStatus
Section titled “outboxStatus”outboxStatus: () =>
Promise<OutboxStatus>
Defined in: packages/client/src/event-lane.ts:192
The current drain signal, read from the store.
Returns
Section titled “Returns”Promise<OutboxStatus>