Interface: GatewayRealtimeConnection
Defined in: src/http/realtime.ts:54
Single-consumer, bounded provider-event connection. An upgrade is not a provider-ready session.
Example
`for await (const event of connection) { if (event.type === 'session.created') break; }`
Extends
AsyncIterableIterator<GatewayRealtimeEvent>
Methods
send()
send(event): void;
Defined in: src/http/realtime.ts:58
Queue a validated event, without replay or a provider-delivery guarantee. Errors reach iteration.
Parameters
| Parameter | Type |
|---|---|
event | GatewayRealtimeEvent |
Returns
void
Example
`connection.send({ type: 'response.create', response: { output_modalities: ['text'] } });`
cancel()
cancel(): Promise<void>;
Defined in: src/http/realtime.ts:62
Close even if iteration never starts; breaking iteration also closes the owned socket.
Returns
Promise<void>
Example
`await connection.cancel();`
next()
next(...__namedParameters): Promise<IteratorResult<GatewayRealtimeEvent, any>>;
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:32
Parameters
| Parameter | Type |
|---|---|
...__namedParameters | [] | [any] |
Returns
Promise<IteratorResult<GatewayRealtimeEvent, any>>
Inherited from
AsyncIterableIterator.next
return()?
optional return(value?): Promise<IteratorResult<GatewayRealtimeEvent, any>>;
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:33
Parameters
| Parameter | Type |
|---|---|
value? | any |
Returns
Promise<IteratorResult<GatewayRealtimeEvent, any>>
Inherited from
AsyncIterableIterator.return
throw()?
optional throw(e?): Promise<IteratorResult<GatewayRealtimeEvent, any>>;
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34
Parameters
| Parameter | Type |
|---|---|
e? | any |
Returns
Promise<IteratorResult<GatewayRealtimeEvent, any>>
Inherited from
AsyncIterableIterator.throw
[asyncIterator]()
asyncIterator: AsyncIterableIterator<GatewayRealtimeEvent, any, any>;
Defined in: node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:45
Returns
AsyncIterableIterator<GatewayRealtimeEvent, any, any>
Inherited from
AsyncIterableIterator.[asyncIterator]