EventQueue
Defined in: packages/server/src/events/queue.ts:77
Properties
Section titled “Properties”ack: (
stream,receipts) =>Promise<number>
Defined in: packages/server/src/events/queue.ts:103
Acknowledge (permanently remove) delivered messages. Returns how many were actually removed.
Parameters
Section titled “Parameters”stream
Section titled “stream”string
receipts
Section titled “receipts”readonly string[]
Returns
Section titled “Returns”Promise<number>
deadLetter
Section titled “deadLetter”deadLetter: (
stream,receipts,reason) =>Promise<number>
Defined in: packages/server/src/events/queue.ts:105
Move delivered messages to dead-letter storage with a recorded reason. Returns how many moved.
Parameters
Section titled “Parameters”stream
Section titled “stream”string
receipts
Section titled “receipts”readonly string[]
reason
Section titled “reason”string
Returns
Section titled “Returns”Promise<number>
enqueueBatch
Section titled “enqueueBatch”enqueueBatch: (
messages,executor?) =>Promise<void>
Defined in: packages/server/src/events/queue.ts:84
Enqueue whole messages. Called by the ingestion endpoint inside its own transaction, so passing
executor is what makes a multi-stream flush batch atomic: every message lands or none does
(ADR-0053 decision 4 — the endpoint never partially enqueues). Without an executor the backend uses its
own handle, and a multi-message call is then only as atomic as that handle.
Parameters
Section titled “Parameters”messages
Section titled “messages”readonly object[]
executor?
Section titled “executor?”Returns
Section titled “Returns”Promise<void>
extendVisibility
Section titled “extendVisibility”extendVisibility: (
stream,receipts,visibilityTimeoutSeconds,executor?) =>Promise<number>
Defined in: packages/server/src/events/queue.ts:96
Push delivered messages’ invisibility out to visibilityTimeoutSeconds FROM NOW — the lease RENEWAL a
consumer runner performs while it is still working through a read (one read makes a whole batch
invisible at once, so without renewal the later messages of a slow batch would become visible to another
runner while the first is still working toward them).
Returns how many were actually extended. A receipt that is no longer queued (already acked or dead-lettered) is simply not counted — a renewal racing a settle is ordinary, never an error.
Parameters
Section titled “Parameters”stream
Section titled “stream”string
receipts
Section titled “receipts”readonly string[]
visibilityTimeoutSeconds
Section titled “visibilityTimeoutSeconds”number
executor?
Section titled “executor?”Returns
Section titled “Returns”Promise<number>
listDeadLetters
Section titled “listDeadLetters”listDeadLetters: (
stream,limit) =>Promise<DeadLetteredEventMessage[]>
Defined in: packages/server/src/events/queue.ts:107
Enumerate an Event stream’s dead-lettered messages, most recent first.
Parameters
Section titled “Parameters”stream
Section titled “stream”string
number
Returns
Section titled “Returns”Promise<DeadLetteredEventMessage[]>
readBatch
Section titled “readBatch”readBatch: (
stream,options) =>Promise<DeliveredEventMessage[]>
Defined in: packages/server/src/events/queue.ts:86
Deliver up to maxMessages messages of one Event stream, made invisible for the visibility timeout.
Parameters
Section titled “Parameters”stream
Section titled “stream”string
options
Section titled “options”Returns
Section titled “Returns”Promise<DeliveredEventMessage[]>
requeueDeadLetter
Section titled “requeueDeadLetter”requeueDeadLetter: (
stream,id) =>Promise<string|null>
Defined in: packages/server/src/events/queue.ts:112
Put one dead-lettered message back on its queue — a DELIBERATE act (ADR-0053 decision 7), never
automatic. Resolves with the requeued message’s new receipt, or null when the id is not dead-lettered.
Parameters
Section titled “Parameters”stream
Section titled “stream”string
string
Returns
Section titled “Returns”Promise<string | null>