Skip to content

Interface: RoomClientEvents<View> ​

Defined in: client/index.ts:72

What a RoomClient reports, for on(event, listener). Each is also an on… option.

Type Parameters ​

Type Parameter
View

Methods ​

state() ​

ts
state(state, seq): void;

Defined in: client/index.ts:74

See RoomClientOptions.onState.

Parameters ​

ParameterType
stateView
seqnumber

Returns ​

void


presence() ​

ts
presence(players): void;

Defined in: client/index.ts:76

See RoomClientOptions.onPresence.

Parameters ​

ParameterType
playersPlayer[]

Returns ​

void


message() ​

ts
message(message): void;

Defined in: client/index.ts:78

See RoomClientOptions.onMessage.

Parameters ​

ParameterType
messageunknown

Returns ​

void


status() ​

ts
status(status, detail?): void;

Defined in: client/index.ts:80

See RoomClientOptions.onStatus.

Parameters ​

ParameterType
statusConnectionStatus
detail?CloseDetail

Returns ​

void


moved() ​

ts
moved(roomId): void;

Defined in: client/index.ts:82

See RoomClientOptions.onMoved.

Parameters ​

ParameterType
roomIdstring

Returns ​

void

MIT licence. Tickflare is an independent project and is not affiliated with Cloudflare.