Methods
emit()
emit(Defined in: src/websocket/types.ts:15props):void
Parameters
| Parameter | Type |
|---|---|
props | { category: string; eventName: string; id: string; } |
props.category | string |
props.eventName | string |
props.id | string |
Returns
void
init()
init(Defined in: src/websocket/types.ts:11props):void
Parameters
| Parameter | Type |
|---|---|
props | { channels?: ClientChannel<unknown>[]; } |
props.channels? | ClientChannel<unknown>[] |
Returns
void
joinChannel()
joinChannel(Defined in: src/websocket/types.ts:16props):void
Parameters
| Parameter | Type |
|---|---|
props | { category: string; id: string; } |
props.category | string |
props.id | string |
Returns
void
leaveChannel()
leaveChannel(Defined in: src/websocket/types.ts:17props):void
Parameters
| Parameter | Type |
|---|---|
props | { category: string; id: string; } |
props.category | string |
props.id | string |
Returns
void
off()
off<Defined in: src/websocket/types.ts:14T>(props):void
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<Defined in: src/websocket/types.ts:12T>(props):void
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<Defined in: src/websocket/types.ts:13T>(props):void
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
props | { category: string; listener: (data) => void; } |
props.category | string |
props.listener | (data) => void |
Returns
void