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