Class: BroadcastChannelTransport — Kata docs
Kata docs

kata-framework


Class: BroadcastChannelTransport

Defined in: packages/kata-sync/src/transports/broadcast-channel.ts:4

Implements

Constructors

Constructor

new BroadcastChannelTransport(): BroadcastChannelTransport;

Returns

BroadcastChannelTransport

Accessors

state

Get Signature

get state(): ConnectionState;

Defined in: packages/kata-sync/src/transports/broadcast-channel.ts:11

Returns

ConnectionState

Implementation of

KataSyncTransport.state

Methods

connect()

connect(roomId): Promise<void>;

Defined in: packages/kata-sync/src/transports/broadcast-channel.ts:15

Parameters

roomId

string

Returns

Promise<void>

Implementation of

KataSyncTransport.connect


disconnect()

disconnect(): void;

Defined in: packages/kata-sync/src/transports/broadcast-channel.ts:32

Returns

void

Implementation of

KataSyncTransport.disconnect


offReceive()

offReceive(handler): void;

Defined in: packages/kata-sync/src/transports/broadcast-channel.ts:57

Parameters

handler

(event) => void

Returns

void

Implementation of

KataSyncTransport.offReceive


onConnectionChange()

onConnectionChange(handler): void;

Defined in: packages/kata-sync/src/transports/broadcast-channel.ts:61

Parameters

handler

(state) => void

Returns

void

Implementation of

KataSyncTransport.onConnectionChange


onReceive()

onReceive(handler): void;

Defined in: packages/kata-sync/src/transports/broadcast-channel.ts:53

Parameters

handler

(event) => void

Returns

void

Implementation of

KataSyncTransport.onReceive


send()

send(event): void;

Defined in: packages/kata-sync/src/transports/broadcast-channel.ts:47

Parameters

event

SyncEvent

Returns

void

Implementation of

KataSyncTransport.send