Interface: GatewayStream<T>
Defined in: src/http/event-stream.ts:8
A single-consumer event stream. Breaking iteration or calling cancel releases the connection.
Example
`for await (const chunk of stream) console.log(chunk);`
Extends
AsyncIterableIterator<T>
Type Parameters
| Type Parameter |
|---|
T |
Methods
cancel()
cancel(reason?): Promise<void>;
Defined in: src/http/event-stream.ts:12
Cancel even if iteration has not started.
Parameters
| Parameter | Type |
|---|---|
reason? | unknown |
Returns
Promise<void>
Example
`await stream.cancel();`
next()
next(...__namedParameters): Promise<IteratorResult<T, any>>;
Defined in: 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/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/typescript/lib/lib.es2018.asynciterable.d.ts:34
Parameters
| Parameter | Type |
|---|---|
e? | any |
Returns
Promise<IteratorResult<T, any>>
Inherited from
AsyncIterableIterator.throw
[asyncIterator]()
asyncIterator: AsyncIterableIterator<T, any, any>;
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:45
Returns
AsyncIterableIterator<T, any, any>
Inherited from
AsyncIterableIterator.[asyncIterator]