ChatClient

new ChatClient(authProvider, options)

Creates a new Twitch chat client.

onAction((channel, user, message, msg) => { /* ... */ })

Fires when a user sends an action (/me) to a channel.

onAuthenticationFailure((message) => { /* ... */ })

Fires when authentication fails.

onBan((channel, user) => { /* ... */ })

Fires when a user is permanently banned from a channel.

onBitsBadgeUpgrade((channel, user, upgradeInfo, msg) => { /* ... */ })

Fires when a user upgrades their bits badge in a channel.

onChatClear((channel) => { /* ... */ })

Fires when the chat of a channel is cleared.

onCommunityPayForward((channel, user, forwardInfo, msg) => { /* ... */ })

Fires when a user pays forward a subscription that was gifted to them to the community.

onCommunitySub((channel, user, subInfo, msg) => { /* ... */ })

Fires when a user gifts random subscriptions to the community of a channel.

Community subs also fire multiple onSubGift events. To prevent alert spam, check Sub gift spam.

onEmoteOnly((channel, enabled) => { /* ... */ })

Fires when emote-only mode is toggled in a channel.

onFollowersOnly((channel, enabled, delay) => { /* ... */ })

Fires when followers-only mode is toggled in a channel.

onGiftPaidUpgrade((channel, user, subInfo, msg) => { /* ... */ })

Fires when a user upgrades their gift subscription to a paid subscription in a channel.

onHost((channel, target, viewers) => { /* ... */ })

Fires when a channel hosts another channel.

onHosted((channel, byChannel, auto, viewers) => { /* ... */ })

Fires when a channel you're logged in as its owner is being hosted by another channel.

onHostsRemaining((channel, numberOfHosts) => { /* ... */ })

Fires when Twitch tells you the number of hosts you have remaining in the next half hour for the channel for which you're logged in as owner after hosting a channel.

onJoin((channel, user) => { /* ... */ })

Fires when a user joins a channel.

The join/part events are cached by the Twitch chat server and will be batched and sent every 30-60 seconds.

Please note that unless you enabled the requestMembershipEvents option, this will only react to your own joins.

onMessage((channel, user, message, msg) => { /* ... */ })

Fires when a user sends a message to a channel.

onMessageFailed((channel, reason) => { /* ... */ })

Fires when sending a message fails.

onMessageRatelimit((channel, message) => { /* ... */ })

Fires when a message you tried to send gets rejected by the ratelimiter.

onMessageRemove((channel, messageId, msg) => { /* ... */ })

Fires when a single message is removed from a channel.

onNoPermission((channel, message) => { /* ... */ })

Fires when you tried to execute a command you don't have sufficient permission for.

onPart((channel, user) => { /* ... */ })

Fires when a user leaves ("parts") a channel.

The join/part events are cached by the Twitch chat server and will be batched and sent every 30-60 seconds.

Please note that unless you enabled the requestMembershipEvents option, this will only react to your own parts.

onPrimeCommunityGift((channel, user, subInfo, msg) => { /* ... */ })

Fires when a user gifts a Twitch Prime benefit to the channel.

onPrimePaidUpgrade((channel, user, subInfo, msg) => { /* ... */ })

Fires when a user upgrades their Prime subscription to a paid subscription in a channel.

onPrivmsg((channel, user, message, msg) => { /* ... */ })

Fires when a user sends a message to a channel.

onR9k((channel, enabled) => { /* ... */ })

Fires when R9K mode is toggled in a channel.

onRaid((channel, user, raidInfo, msg) => { /* ... */ })

Fires when a user raids a channel.

onRaidCancel((channel, msg) => { /* ... */ })

Fires when a user cancels a raid.

onResub((channel, user, subInfo, msg) => { /* ... */ })

Fires when a user resubscribes to a channel.

onRewardGift((channel, user, rewardGiftInfo, msg) => { /* ... */ })

Fires when a user gifts rewards during a special event.

onRitual((channel, user, ritualInfo, msg) => { /* ... */ })

Fires when a user performs a "ritual" in a channel.

onSlow((channel, enabled, delay) => { /* ... */ })

Fires when slow mode is toggled in a channel.

onStandardPayForward((channel, user, forwardInfo, msg) => { /* ... */ })

Fires when a user pays forward a subscription that was gifted to them to a specific user.

onSub((channel, user, subInfo, msg) => { /* ... */ })

Fires when a user subscribes to a channel.

onSubExtend((channel, user, subInfo, msg) => { /* ... */ })

Fires when a user extends their subscription using a Sub Token.

onSubGift((channel, user, subInfo, msg) => { /* ... */ })

Fires when a user gifts a subscription to a channel to another user.

Community subs also fire multiple onSubGift events. To prevent alert spam, check Sub gift spam.

onSubsOnly((channel, enabled) => { /* ... */ })

Fires when sub only mode is toggled in a channel.

onTimeout((channel, user, duration) => { /* ... */ })

Fires when a user is timed out from a channel.

onUnhost((channel) => { /* ... */ })

Fires when host mode is disabled in a channel.

onWhisper((user, message, msg) => { /* ... */ })

Fires when receiving a whisper from another user.

onAnyMessage

Type: (handler: (msg: Message) => void) => Listener

onConnect

Type: (handler: () => void) => Listener

onCtcp

Type: (handler: (target: string, user: string, command: string, params: string, msg: PrivateMessage) => void) => Listener

onCtcpReply

Type: (handler: (target: string, user: string, command: string, params: string, msg: Notice) => void) => Listener

onDisconnect

Type: (handler: (manually: boolean, reason: Error) => void) => Listener

onNickChange

Type: (handler: (oldNick: ?string, newNick: string, msg: NickChange) => void) => Listener

onNotice

Type: (handler: (target: string, user: string, message: string, msg: Notice) => void) => Listener

onRegister

Type: (handler: () => void) => Listener

currentNick

Type: string

isConnected

Type: boolean

isConnecting

Type: boolean

isRegistered

Type: boolean

port

Type: number

serverProperties

Type: ServerProperties

anonymous(options)

Creates a new anonymous Twitch chat client.

forTwitchClient(authProvider, options)

Creates a new Twitch chat client with the user info from the AuthProvider instance.

action(channel, message)

Sends an action message (/me) to a channel.

addCapability(cap)

addListener<Args>(event, listener)

addVip(channel, user)

Gives a user VIP status in a channel.

addVIP(channel, user)

ban(channel, user, reason)

Bans a user from a channel.

changeColor(color)

Changes your username color.

clear(channel)

Clears all messages in a channel.

connect()

createMessage<T>(type, params, tags)

deleteMessage(channel, message)

Deletes a message from a channel.

disableEmoteOnly(channel)

Disables emote-only mode in a channel.

disableFollowersOnly(channel)

Disables followers-only mode in a channel.

disableR9k(channel)

Disables r9k mode in a channel.

disableSlow(channel)

Disables slow mode in a channel.

disableSubsOnly(channel)

Disables subscribers-only mode in a channel.

enableEmoteOnly(channel)

Enables emote-only mode in a channel.

enableFollowersOnly(channel, minFollowTime)

Enables followers-only mode in a channel.

enableR9k(channel)

Enables r9k mode in a channel.

enableSlow(channel, delayBetweenMessages)

Enables slow mode in a channel.

enableSubsOnly(channel)

Enables subscribers-only mode in a channel.

getCommandClass(command)

getMods(channel)

Retrieves a list of moderators in a channel.

getVips(channel)

Retrieves a list of VIPs in a channel.

getVIPs(channel)

host(channel, target)

Hosts a channel on another channel.

join(channel)

Joins a channel.

knowsCommand(command)

mod(channel, user)

Gives a user moderator rights in a channel.

on<Args>(event, listener)

onNamedMessage<T>(commandName, handler, handlerName)

onTypedMessage<T>(type, handler, handlerName)

part(channel)

Leaves a channel ("part" in IRC terms).

pingCheck()

purge(channel, user, reason)

Removes all messages of a user from a channel.

quit()

Disconnects from the chat server.

raid(channel, target)

Starts a raid on a channel.

receiveLine(line)

reconnect(message)

registerCapability(cap)

registerEvent<T>()

registerMessageType(cls)

removeListener(id)

removeListener(event, listener)

removeMessageListener(handlerName)

removeVip(channel, user)

Takes VIP status from a user in a channel.

removeVIP(channel, user)

runCommercial(channel, duration)

Runs a commercial break on a channel.

say(channel, message, attributes)

Sends a message to a channel.

send(message)

sendCtcp(target, type, message)

sendMessage<T>(type, params, tags)

sendMessageAndCaptureReply<T>(type, params)

sendRaw(line)

timeout(channel, user, duration, reason)

Times out a user in a channel and removes all their messages.

unhost(channel)

Ends any host on a channel.

This only works when in the channel that was hosted in order to provide feedback about success of the command.

If you don't need this feedback, consider using ChatClient#unhostOutside instead.

unhostOutside(channel)

Ends any host on a channel.

This works even when not in the channel that was hosted, but provides no feedback about success of the command.

If you need feedback about success, use ChatClient#unhost (but make sure you're in the channel you are hosting).

unmod(channel, user)

Takes moderator rights from a user in a channel.

unraid(channel)

Ends a raid on a channel.

waitForRegistration()

Waits for authentication (or "registration" in IRC terms) to finish.

whisper(user, message)

Sends a whisper message to another user.