kata-framework

Class: WebSocketTransport

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

Implements

• KataSyncTransport

Constructors

Constructor

new WebSocketTransport(url, options): WebSocketTransport;

Defined in: packages/kata-sync/src/transports/websocket.ts:19

Parameters

url

string

options

WebSocketTransportOptions

Returns

WebSocketTransport

Accessors

state

Get Signature

get state(): ConnectionState;

Defined in: packages/kata-sync/src/transports/websocket.ts:24

Returns

ConnectionState

Implementation of

KataSyncTransport.state

Methods

connect()

connect(roomId): Promise<void>;

Defined in: packages/kata-sync/src/transports/websocket.ts:28

Parameters

roomId

string

Returns

Promise<void>

Implementation of

KataSyncTransport.connect

disconnect()

disconnect(): void;

Defined in: packages/kata-sync/src/transports/websocket.ts:80

Returns

void

Implementation of

KataSyncTransport.disconnect

offReceive()

offReceive(handler): void;

Defined in: packages/kata-sync/src/transports/websocket.ts:99

Parameters

handler

(event) => void

Returns

void

Implementation of

KataSyncTransport.offReceive

onConnectionChange()

onConnectionChange(handler): void;

Defined in: packages/kata-sync/src/transports/websocket.ts:103

Parameters

handler

(state) => void

Returns

void

Implementation of

KataSyncTransport.onConnectionChange

onReceive()

onReceive(handler): void;

Defined in: packages/kata-sync/src/transports/websocket.ts:95

Parameters

handler

(event) => void

Returns

void

Implementation of

KataSyncTransport.onReceive

send()

send(event): void;

Defined in: packages/kata-sync/src/transports/websocket.ts:89

Parameters

event

SyncEvent

Returns

void

Implementation of

KataSyncTransport.send