src/sockets/events/generic/event-channel-command.ts
The command interface for adding or removing event channels to the socket.
Properties |
| command |
command:
|
Type : CommandType
|
|
ADD or REMOVE access to a channel |
| domainId |
domainId:
|
Type : string
|
|
The Domain ID (Name) |
| topic |
topic:
|
Type : string
|
|
The name of the channel |
export type CommandType = 'ADD' | 'REMOVE';
/**
* The command interface for adding or removing event channels to the socket.
*/
export interface IEventChannelCommand {
/** ADD or REMOVE access to a channel */
command: CommandType;
/** The Domain ID (Name) */
domainId: string;
/** The name of the channel */
topic: string;
}