MessageStream
Defined in: sdks/js/node-sdk/src/MessageStream.ts:34
One pending item. Construction selects callback mode or next-request acknowledgement.
Type Parameters
Section titled “Type Parameters”T
V
Implements
Section titled “Implements”AsyncIterable<V>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MessageStream<
T,V>(reader,convert,options?):MessageStream<T,V>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:48
Parameters
Section titled “Parameters”reader
Section titled “reader”convert
Section titled “convert”(message, cursor) => V | Promise<V | undefined> | undefined
options?
Section titled “options?”StreamOptions<T, V> = {}
Returns
Section titled “Returns”MessageStream<T, V>
Properties
Section titled “Properties”end: () =>
Promise<IteratorReturnResult<undefined>>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:207
Returns
Section titled “Returns”Promise<IteratorReturnResult<undefined>>
Accessors
Section titled “Accessors”deliveredCursor
Section titled “deliveredCursor”Get Signature
Section titled “Get Signature”get deliveredCursor():
DeliveryCursor|undefined
Defined in: sdks/js/node-sdk/src/MessageStream.ts:69
Returns
Section titled “Returns”DeliveryCursor | undefined
isDone
Section titled “isDone”Get Signature
Section titled “Get Signature”get isDone():
boolean
Defined in: sdks/js/node-sdk/src/MessageStream.ts:66
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator]():
MessageStream<T,V>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:215
Returns
Section titled “Returns”MessageStream<T, V>
Implementation of
Section titled “Implementation of”AsyncIterable.[asyncIterator]
catchUpChanged()
Section titled “catchUpChanged()”catchUpChanged():
Promise<MessageCatchUp>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:214
Returns
Section titled “Returns”Promise<MessageCatchUp>
catchUpSnapshot()
Section titled “catchUpSnapshot()”catchUpSnapshot():
MessageCatchUp|Promise<MessageCatchUp>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:213
Returns
Section titled “Returns”MessageCatchUp | Promise<MessageCatchUp>
next()
Section titled “next()”next():
Promise<IteratorResult<V,undefined>>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:77
Returns
Section titled “Returns”Promise<IteratorResult<V, undefined>>
return()
Section titled “return()”return():
Promise<IteratorReturnResult<undefined>>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:196
Returns
Section titled “Returns”Promise<IteratorReturnResult<undefined>>
updateFilter()
Section titled “updateFilter()”updateFilter(
conversationType?,consentStates?):void|Promise<void>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:209
Parameters
Section titled “Parameters”conversationType?
Section titled “conversationType?”consentStates?
Section titled “consentStates?”Returns
Section titled “Returns”void | Promise<void>
updateScope()
Section titled “updateScope()”updateScope(
groupIds?):void|Promise<void>
Defined in: sdks/js/node-sdk/src/MessageStream.ts:208
Parameters
Section titled “Parameters”groupIds?
Section titled “groupIds?”string[]
Returns
Section titled “Returns”void | Promise<void>