ws-asyncapi API / core / StreamHandler

Type Alias: StreamHandler<WebsocketData, Topics, Message, Output, Query, Headers, Params, Data>

StreamHandler<WebsocketData, Topics, Message, Output, Query, Headers, Params, Data> = (data) => AsyncIterable<Output>

Defined in: .api-entries/core/index.d.ts:252

Handler for a stream (.stream()). Same context as RpcHandler, but it returns an async iterable (typically an async function*) whose yielded values are each validated against output and pushed to the client as they arrive. The client consumes them with for await. If the consumer stops iterating, the iterator is return()-ed so a try/finally in the generator can clean up.

Type Parameters

WebsocketData

WebsocketData extends WebsocketDataType

Topics

Topics extends string

Message

Message

Output

Output

Query

Query extends unknown | undefined

Headers

Headers extends unknown | undefined

Params

Params extends unknown | undefined

Data

Data

Parameters

data

ws

WebSocketImplementation<WebsocketData, Topics>

message

Message

request

RequestData<Query, Headers, Params>

data

Data

signal

AbortSignal

aborts when the client cancels or disconnects — wire long tasks to it

Returns

AsyncIterable<Output>