subscribe | SignalWire

subscribe(channels): Promise<void>

List of channels for which you want to receive messages.

Note that the subscribe function is idempotent, and calling it again with a different set of channels will not unsubscribe you from the old ones. To unsubscribe, use unsubscribe.

Parameters

Name	Type	Description
`channels`	`string` \| `string[]`	The channels to subscribe to, either in the form of a string (for one channel) or an array of strings.

Returns

Promise<void>

Example

1 const chatClient = new Chat.Client({
2   project: "<project-id>",
3   token: "<api-token>",
4 });
5 
6 chatClient.on("message", (m) => console.log(m));
7 
8 await chatClient.subscribe("my-channel");
9 await chatClient.subscribe(["chan-2", "chan-3"]);