Class ClientToClientCommands

Index

Constructors

Methods

channels readMessages sendMessage subscribe unsubscribe

Constructors

constructor

new ClientToClientCommands(protocol: MPDProtocol): ClientToClientCommands
Parameters
- protocol: MPDProtocol
Returns ClientToClientCommands
- Defined in src/core/commands/clientToClient.ts:5

Methods

channels

channels(): Promise<string[]>
Obtain a list of all channels.

Returns Promise<string[]>
- Defined in src/core/commands/clientToClient.ts:27

readMessages

readMessages(): Promise<Map<string, string[]>>
Reads messages for this client. Returns a Map containing the messages grouped by channel name.

Returns Promise<Map<string, string[]>>
- Defined in src/core/commands/clientToClient.ts:35

sendMessage

sendMessage(channel: string, text: string): Promise<void>
Send a message to the specified channel.
Parameters
- channel: string
- text: string
Returns Promise<void>
- Defined in src/core/commands/clientToClient.ts:52

subscribe(channel: string): Promise<void>
Subscribe to a channel. The channel is created if it does not exist already. The name may consist of alphanumeric ASCII characters plus underscore, dash, dot and colon.
Parameters
- channel: string
Returns Promise<void>
- Defined in src/core/commands/clientToClient.ts:11

unsubscribe

unsubscribe(channel: string): Promise<void>
Unsubscribe from a channel.
Parameters
- channel: string
Returns Promise<void>
- Defined in src/core/commands/clientToClient.ts:19