Class BaseTransport`Abstract`

Hierarchy (View Summary)

BaseTransport

Implements

Transport

Index

Constructors

Accessors

Methods

createMessage serialize deserialize validate on off connect disconnect send destroy

Constructors

constructor

new BaseTransport(): BaseTransport
Returns BaseTransport

Accessors

state

get state(): TransportState
Returns TransportState
Implementation of Transport.state
- Defined in transport/transport.ts:47

Methods

`Static`createMessage

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

`Static`serialize

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

`Static`deserialize

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

`Static`validate

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

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
Implementation of Transport.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
Implementation of Transport.off
- Defined in transport/transport.ts:71

`Abstract`connect

connect(): Promise<void>
Returns Promise<void>
Implementation of Transport.connect
- Defined in transport/transport.ts:129

`Abstract`disconnect

disconnect(reason?: string): void
Parameters
- Optionalreason: string
Returns void
Implementation of Transport.disconnect
- Defined in transport/transport.ts:130

`Abstract`send

send(message: TransportMessage): void
Parameters
- message: TransportMessage
Returns void
Implementation of Transport.send
- Defined in transport/transport.ts:131

destroy

destroy(): void
Returns void
Implementation of Transport.destroy
- Defined in transport/transport.ts:133