BaseChatClientOptions

{ }

botLevel

Type:

TwitchBotLevel

A Twitch bot level, i.e. whether you're connecting as a known or verified bot.

Aliased type: "none" | "known" | "verified"

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

Type: ?ResolvableValue<Array<string>>

Channels to join after connecting.

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

hostName

Type: ?string

Custom hostname for connecting to chat.

isAlwaysMod

Type: ?boolean

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 subjects you to messages possibly silently not being delivered and your bot possibly getting banned if your bot is not a mod in one of the channels.

legacyScopes

Type: ?boolean

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.

logger

Type: ?Partial<LoggerOptions>

Options to pass to the logger.

readOnly

Type: ?boolean

Whether to request a token with only read permission.

Ignored if legacyScopes is true.

requestMembershipEvents

Type: ?boolean

Whether to receive JOIN and PART messages from Twitch chat.

ssl

Type: ?boolean

Whether to connect securely using SSL.

You should not disable this except for debugging purposes.

webSocket

Type: ?boolean

Whether to use a WebSocket to connect to chat.