MessageStream
Defined in: sdks/browser/dist/typescript-wasm/runtime/public/streams.d.ts:52
Messages in delivery order. The stream holds its client while it is open.
Without options.from, one default message reader owns delivery progress
for the client database. Another default reader fails with ConsumerOwned,
even if it selects a different group, DM, or filter.
An explicit options.from cursor starts an independent replay/live reader.
Such readers can run in parallel and do not change default delivery progress.
Their progress is not a separate durable consumer checkpoint. Save the last
processed message’s deliveryCursor if the app must resume this replay.
Each next read acknowledges the prior message. Await processing before the
next read, or use onValue() and await all work in its callback. An app queue
or an unawaited task does not delay acknowledgement. end() and return()
do not acknowledge the last message. They cannot undo an acknowledgement after
its commit has been admitted.
Extends
Section titled “Extends”ReaderStream<Message>
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator]():
AsyncIterableIterator<Message>
Defined in: sdks/browser/dist/typescript-wasm/runtime/streams/reader.d.ts:26
Returns
Section titled “Returns”AsyncIterableIterator<Message>
Inherited from
Section titled “Inherited from”ReaderStream.[asyncIterator]
end():
Promise<void>
Defined in: sdks/browser/dist/typescript-wasm/runtime/streams/reader.d.ts:41
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”ReaderStream.end
next()
Section titled “next()”next():
Promise<IteratorResult<Message,any>>
Defined in: sdks/browser/dist/typescript-wasm/runtime/streams/reader.d.ts:33
Reads run one at a time. For messages, the next read acknowledges the prior message. Await app processing before requesting the next message. Sharing this iterator with an app queue does not extend the acknowledgement boundary.
Returns
Section titled “Returns”Promise<IteratorResult<Message, any>>
Inherited from
Section titled “Inherited from”ReaderStream.next
onValue()
Section titled “onValue()”onValue(
callback):Promise<void>
Defined in: sdks/browser/dist/typescript-wasm/runtime/streams/reader.d.ts:39
Await each callback before the next read. For messages, that read acknowledges the prior message. Await all processing in the callback. Work sent to an app queue or an unawaited task can continue after acknowledgement.
Parameters
Section titled “Parameters”callback
Section titled “callback”(value) => void | Promise<void>
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”ReaderStream.onValue
ready()
Section titled “ready()”ready():
Promise<void>
Defined in: sdks/browser/dist/typescript-wasm/runtime/streams/reader.d.ts:27
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”ReaderStream.ready
return()
Section titled “return()”return():
Promise<IteratorResult<Message,any>>
Defined in: sdks/browser/dist/typescript-wasm/runtime/streams/reader.d.ts:40
Returns
Section titled “Returns”Promise<IteratorResult<Message, any>>
Inherited from
Section titled “Inherited from”ReaderStream.return