WebsocketClientProvider

API Reference / modelence / index / WebsocketClientProvider

Defined in: packages/modelence/src/websocket/types.ts:10

Methods

emit()

emit(props): void

Defined in: packages/modelence/src/websocket/types.ts:15

Parameters

Parameter	Type
props	{ category: string; eventName: string; id: string; }
props.category	string
props.eventName	string
props.id	string

Returns

void

---

init()

init(props): void

Defined in: packages/modelence/src/websocket/types.ts:11

Parameters

Parameter	Type
props	{ channels?: ClientChannel<unknown>[]; }
props.channels?	ClientChannel<unknown>[]

Returns

void

---

joinChannel()

joinChannel(props): void

Defined in: packages/modelence/src/websocket/types.ts:16

Parameters

Parameter	Type
props	{ category: string; id: string; }
props.category	string
props.id	string

Returns

void

---

leaveChannel()

leaveChannel(props): void

Defined in: packages/modelence/src/websocket/types.ts:17

Parameters

Parameter	Type
props	{ category: string; id: string; }
props.category	string
props.id	string

Returns

void

---

off()

off<T>(props): void

Defined in: packages/modelence/src/websocket/types.ts:14

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
props	{ category: string; listener: (data) => void; }
props.category	string
props.listener	(data) => void

Returns

void

---

on()

on<T>(props): void

Defined in: packages/modelence/src/websocket/types.ts:12

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
props	{ category: string; listener: (data) => void; }
props.category	string
props.listener	(data) => void

Returns

void

---

once()

once<T>(props): void

Defined in: packages/modelence/src/websocket/types.ts:13

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
props	{ category: string; listener: (data) => void; }
props.category	string
props.listener	(data) => void

Returns

void