twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

Basic usage

Getting startedConnecting to ChatListening to events

Upgrading

Upgrading to 2.xUpgrading to 3.xUpgrading to 4.x

Examples

Basic botPreventing sub gift spam

Classes

ChatClientChatUserTwitchPrivateMessageUserNotice

Interfaces

BaseChatClientOptionsChatBitsBadgeUpgradeInfoChatCommunityPayForwardInfoChatCommunitySubInfoChatPrimeCommunityGiftInfoChatRaidInfoChatRewardGiftInfoChatRitualInfoChatSayMessageAttributesChatStandardPayForwardInfoChatSubExtendInfoChatSubGiftInfoChatSubGiftUpgradeInfoChatSubInfoChatSubUpgradeInfoParsedMessageCheerPartParsedMessageEmotePartParsedMessageTextPartTcpChatClientOptionsWebSocketChatClientOptions

BaseChatClientOptions

Options for a chat client.

{
Your bot level, i.e. whether you're a known or verified bot.
botLevel?:
TwitchBotLevel

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

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

Channels to join after connecting.
channels?: ResolvableValue<Array<string>>
Custom hostname for connecting to chat.
hostName?: string
Whether you're guaranteed to be a mod in all joined channels.
isAlwaysMod?: boolean
Whether to request a token with the old chat permission scope.
legacyScopes?: boolean
Options to pass to the logger.
logger?: Partial<LoggerOptions>
The minimum log level of messages that will be sent from the underlying IRC client.
logLevel?: LogLevel
Whether to request a token with only read permission.
readOnly?: boolean
Whether to receive JOIN and PART messages from Twitch chat.
Whether to connect securely using SSL.
ssl?: boolean
Whether to use a WebSocket to connect to chat.
webSocket?: boolean
}

Properties

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.

Starting with 5.0, this will default to 'none', which will limit 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.

logLevel

Type: ?LogLevel

Deprecated.

Use logger.minLevel instead.

The minimum log level of messages that will be sent from the underlying IRC client.

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.