API reference / @chanx-js/client / core / MessageStream

Interface: MessageStream<T>

Defined in: packages/client/src/core/stream.ts:12

Extends

• AsyncIterableIterator<T>

Type Parameters

Type Parameter
T

Properties

close

close: () => void;

Defined in: packages/client/src/core/stream.ts:14

Stop iterating and release the underlying subscription.

Returns

void

---

pending

readonly pending: number;

Defined in: packages/client/src/core/stream.ts:16

Messages queued because the consumer has not asked for them yet.

Methods

[asyncIterator]()

asyncIterator: AsyncIterableIterator<T, any, any>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:45

Returns

AsyncIterableIterator<T, any, any>

Inherited from

AsyncIterableIterator.[asyncIterator]

---

next()

next(...__namedParameters): Promise<IteratorResult<T, any>>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:32

Parameters

Parameter	Type
...__namedParameters	[] | [any]

Returns

Promise<IteratorResult<T, any>>

Inherited from

AsyncIterableIterator.next

---

return()?

optional return(value?): Promise<IteratorResult<T, any>>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:33

Parameters

Parameter	Type
value?	any

Returns

Promise<IteratorResult<T, any>>

Inherited from

AsyncIterableIterator.return

---

throw()?

optional throw(e?): Promise<IteratorResult<T, any>>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34

Parameters

Parameter	Type
e?	any

Returns

Promise<IteratorResult<T, any>>

Inherited from

AsyncIterableIterator.throw