ChatClientOptions

The intents to use to query the auth provider.

The "chat" intent will always be queried last, after the ones you give here.

The authentication provider to use for getting the chat credentials.

If you don't pass this, the chat client will connect anonymously.

Your bot level, i.e. whether you're a known or verified bot.

This defaults to 'none', which limits your messages to the standard rate limit.

Channels to join after connecting.

May also be a function (sync or async) that returns a list of channels.

The connection options for a WebSocket connection.

If not using WebSockets, this is ignored.

Custom hostname for connecting to chat.

Whether you're guaranteed to be a mod in all joined channels.

This raises the rate limit and lifts the one-second-between-messages rule, but if your bot is not a mod in one of the channels, it subjects you to messages possibly silently not being delivered and your bot possibly getting banned.

Whether to request a token with the old chat permission scope.

If you're not sure whether this is necessary, just try leaving this off, and if it doesn't work, turn it on and try again.

Options to pass to the logger.

Whether to request a token with only read permission.

Ignored if legacyScopes is true.

Whether to rejoin the channels the client had joined when a reconnect occurs.

This means that the channels option will only be resolved on the initial connection.

Whether to receive JOIN and PART messages from Twitch chat.

Whether to connect securely using SSL.

You should not disable this except for debugging purposes.

Whether to use a WebSocket to connect to chat.