Transport
Defined in: packages/transports/src/transport.ts:13
What the Client talks to the radio through: connect, write one frame payload, receive frame events, and close. Transports add and strip the framing of their medium; reconnection and protocol belong to the client.
Extends
TypedEmitter<TransportEvents>
Properties
connected
readonly connected: boolean;Defined in: packages/transports/src/transport.ts:15
kind
readonly kind: TransportKind;Defined in: packages/transports/src/transport.ts:14
Methods
close()
close(): Promise<void>;Defined in: packages/transports/src/transport.ts:18
Returns
Promise<void>
connect()
connect(signal?): Promise<void>;Defined in: packages/transports/src/transport.ts:16
Parameters
signal?
AbortSignal
Returns
Promise<void>
emit()
emit<K>(event, ...args): boolean;Defined in: packages/transports/src/typed-emitter.ts:44
Type Parameters
K
K extends string
Parameters
event
K
Event name
args
...TransportEvents[K]
Event arguments
Returns
boolean
Inherited from
listenerCount()
listenerCount<K>(event): number;Defined in: packages/transports/src/typed-emitter.ts:49
Type Parameters
K
K extends string
Parameters
event
K
Event name
Returns
number
Inherited from
off()
off<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:35
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<TransportEvents[K]>
Listener to remove
Returns
this
Inherited from
on()
on<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:17
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<TransportEvents[K]>
Called with the event arguments
Returns
this
Inherited from
once()
once<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:26
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<TransportEvents[K]>
Called once with the event arguments
Returns
this
Inherited from
removeAllListeners()
removeAllListeners<K>(event?): this;Defined in: packages/transports/src/typed-emitter.ts:54
Type Parameters
K
K extends string
Parameters
event?
K
Event name, or every event when omitted
Returns
this
Inherited from
TypedEmitter.removeAllListeners
write()
write(payload): Promise<void>;Defined in: packages/transports/src/transport.ts:17
Parameters
payload
Uint8Array
Returns
Promise<void>