MockTransport

Defined in: packages/transports/src/mock/mock-transport.ts:9

In-memory Transport: the app's writes go to a handler, receive() emits a frame as if the radio sent it, simulateDisconnect() a lost link.

Extends

• TypedEmitter<TransportEvents>

Implements

• Transport

Constructors

Constructor

new MockTransport(): MockTransport;

Returns

MockTransport

Inherited from

TypedEmitter<TransportEvents>.constructor

Properties

connectCount

connectCount: number = 0;

Defined in: packages/transports/src/mock/mock-transport.ts:15

kind

readonly kind: "mock" = 'mock';

Defined in: packages/transports/src/mock/mock-transport.ts:10

Implementation of

Transport.kind

written

readonly written: Uint8Array<ArrayBufferLike>[] = [];

Defined in: packages/transports/src/mock/mock-transport.ts:11

Accessors

connected

Get Signature

get connected(): boolean;

Defined in: packages/transports/src/mock/mock-transport.ts:17

Returns

boolean

Implementation of

Transport.connected

Methods

close()

close(): Promise<void>;

Defined in: packages/transports/src/mock/mock-transport.ts:51

Returns

Promise<void>

Implementation of

Transport.close

connect()

connect(signal?): Promise<void>;

Defined in: packages/transports/src/mock/mock-transport.ts:32

Parameters

signal?

AbortSignal

Aborts the connection attempt

Returns

Promise<void>

Implementation of

Transport.connect

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

Implementation of

Transport.emit

Inherited from

TypedEmitter.emit

failNextConnect()

failNextConnect(error?): void;

Defined in: packages/transports/src/mock/mock-transport.ts:27

Parameters

error?

Error = ...

Rejection of the next connect. Default a ConnectionError

Returns

void

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

Implementation of

Transport.listenerCount

Inherited from

TypedEmitter.listenerCount

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

Implementation of

Transport.off

Inherited from

TypedEmitter.off

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

Implementation of

Transport.on

Inherited from

TypedEmitter.on

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

Implementation of

Transport.once

Inherited from

TypedEmitter.once

receive()

receive(payload): void;

Defined in: packages/transports/src/mock/mock-transport.ts:56

Parameters

payload

Uint8Array

Frame payload from the radio

Returns

void

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

Implementation of

Transport.removeAllListeners

Inherited from

TypedEmitter.removeAllListeners

setRadio()

setRadio(handler): void;

Defined in: packages/transports/src/mock/mock-transport.ts:22

Parameters

handler

RadioHandler | null

Answers the written frames, or null

Returns

void

simulateDisconnect()

simulateDisconnect(error?): void;

Defined in: packages/transports/src/mock/mock-transport.ts:63

Parameters

error?

Error = ...

Reason given to the close event

Returns

void

write()

write(payload): Promise<void>;

Defined in: packages/transports/src/mock/mock-transport.ts:45

Parameters

payload

Uint8Array

Frame payload without framing

Returns

Promise<void>

Implementation of

Transport.write