remote / Exports / WebSocketTransport
Class: WebSocketTransport
Simplified WebSocket Transport with Type Safety
Implements
Transport
Table of contents
Constructors
Methods
Constructors
constructor
• new WebSocketTransport(config): WebSocketTransport
Parameters
| Name | Type |
|---|---|
config | SimpleWebSocketConfig |
Returns
Defined in
transport/websocket-transport-simple.ts:42
Methods
connect
▸ connect(): Promise<void>
Returns
Promise<void>
Implementation of
Transport.connect
Defined in
transport/websocket-transport-simple.ts:55
disconnect
▸ disconnect(): Promise<void>
Returns
Promise<void>
Implementation of
Transport.disconnect
Defined in
transport/websocket-transport-simple.ts:94
send
▸ send<TData>(request): Promise<TransportResponse<TData>>
Type parameters
| Name |
|---|
TData |
Parameters
| Name | Type |
|---|---|
request | TransportRequest<ChatRequestBody> |
Returns
Promise<TransportResponse<TData>>
Implementation of
Transport.send
Defined in
transport/websocket-transport-simple.ts:110
sendStream
▸ sendStream<TData>(request): AsyncIterable<TData, any, any>
Type parameters
| Name |
|---|
TData |
Parameters
| Name | Type |
|---|---|
request | TransportRequest<ChatRequestBody> |
Returns
AsyncIterable<TData, any, any>
Implementation of
Transport.sendStream
Defined in
transport/websocket-transport-simple.ts:140
isConnected
▸ isConnected(): boolean
Returns
boolean
Implementation of
Transport.isConnected
Defined in
transport/websocket-transport-simple.ts:146
getCapabilities
▸ getCapabilities(): TransportCapabilities
Returns
TransportCapabilities
Implementation of
Transport.getCapabilities