StreamSession
Defined in: src/client/types.ts:67
A live streaming method call. Exchange methods drive the server with StreamSession.exchange; producer methods are consumed by async iteration. Always StreamSession.close when done.
Properties
Section titled “Properties”header
Section titled “header”readonly header: Record<string, any> | null;Defined in: src/client/types.ts:69
The method’s header row (returned once at stream start), or null if the method declares no header.
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”asyncIterator: AsyncIterableIterator<Record<string, any>[]>;Defined in: src/client/types.ts:76
Iterate the server-produced output batches one row-array at a time (producer streams).
Returns
Section titled “Returns”AsyncIterableIterator<Record<string, any>[]>
close()
Section titled “close()”close(): void;Defined in: src/client/types.ts:78
Tear down the stream, flushing/draining the underlying transport.
Returns
Section titled “Returns”void
exchange()
Section titled “exchange()”exchange(input): Promise<Record<string, any>[]>;Defined in: src/client/types.ts:71
Send one batch of input rows and receive the server’s corresponding output rows (exchange streams).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input |
ExchangeInput |
Returns
Section titled “Returns”Promise<Record<string, any>[]>
tick()
Section titled “tick()”tick(metadata?): Promise<Record<string, any>[]>;Defined in: src/client/types.ts:74
Send one producer tick with optional application custom metadata and return the rows emitted for that tick.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
metadata? |
ReadonlyMap<string, string> |
Returns
Section titled “Returns”Promise<Record<string, any>[]>