Class WebSocketTransport

Hierarchy (View Summary)

BaseTransport
- WebSocketTransport

Index

Constructors

Accessors

Methods

on off createMessage serialize deserialize validate connect disconnect send destroy

Constructors

constructor

new WebSocketTransport(config: WebSocketTransportConfig): WebSocketTransport
Parameters
- config: WebSocketTransportConfig
Returns WebSocketTransport
Overrides BaseTransport.constructor
- Defined in transport/websocket.ts:25

Accessors

state

get state(): TransportState
Returns TransportState
Inherited from BaseTransport.state
- Defined in transport/transport.ts:47

Methods

on

on<K extends keyof TransportEventMap>(
event: K,
callback: EventCallback<K>,
): () => void
Type Parameters
- K extends keyof TransportEventMap
Parameters
- event: K
- callback: EventCallback<K>
Returns () => void
Inherited from BaseTransport.on
- Defined in transport/transport.ts:60

off

off<K extends keyof TransportEventMap>(
event: K,
callback: EventCallback<K>,
): void
Type Parameters
- K extends keyof TransportEventMap
Parameters
- event: K
- callback: EventCallback<K>
Returns void
Inherited from BaseTransport.off
- Defined in transport/transport.ts:71

`Static`createMessage

createMessage(type: MessageType, payload: unknown): TransportMessage
Parameters
- type: MessageType
- payload: unknown
Returns TransportMessage
Inherited from BaseTransport.createMessage
- Defined in transport/transport.ts:92

`Static`serialize

serialize(message: TransportMessage): string
Parameters
- message: TransportMessage
Returns string
Inherited from BaseTransport.serialize
- Defined in transport/transport.ts:101

`Static`deserialize

deserialize(raw: string): TransportMessage
Parameters
- raw: string
Returns TransportMessage
Inherited from BaseTransport.deserialize
- Defined in transport/transport.ts:105

`Static`validate

validate(candidate: unknown): asserts candidate is TransportMessage
Parameters
- candidate: unknown
Returns asserts candidate is TransportMessage
Inherited from BaseTransport.validate
- Defined in transport/transport.ts:111

connect

connect(): Promise<void>
Returns Promise<void>
Overrides BaseTransport.connect
- Defined in transport/websocket.ts:42

disconnect

disconnect(reason?: string): void
Parameters
- reason: string = 'client_disconnect'
Returns void
Overrides BaseTransport.disconnect
- Defined in transport/websocket.ts:50

send

send(message: TransportMessage): void
Parameters
- message: TransportMessage
Returns void
Overrides BaseTransport.send
- Defined in transport/websocket.ts:77

destroy

destroy(): void
Returns void
Overrides BaseTransport.destroy
- Defined in transport/websocket.ts:89