twitch-commando 2.0.1 | Documentation

twitch-commando

2.0.1

TwitchChatChannel
name
id
say
CommandoConstants
ClientOptions
TwitchCommandoClient ▸
- Static members
- .enableVerboseLogging
- .connect
- .say
- .action
- .whisper
- .registerCommandsIn
- .registerDetaultCommands
- .setProvider
- .join
- .part
- .getUsername
- .getChannels
- .isOwner
CommandArgument
CommandOptions
TwichChatCommand ▸
- Static members
- .run
TwitchChatMessage ▸
- Static members
- .text
- .author
- .id
- .channel
- .color
- .emotes
- .timestamp
- .messageType
- .reply
- .actionReply
TwitchChatUser ▸
- Static members
- .name
- .username
- .mod
- .badges
- .subscriber
- .id
- .userType
- .turbo
- .whisper
- .channel
- .isBroadcaster

Need help reading this?

TwitchChatChannel

Twitch Channel object

new TwitchChatChannel(originalMessage: Object, client: TwitchCommandoClient)

Parameters

originalMessage (Object)

client (TwitchCommandoClient)

name

Channel name

name

id

Channel ID

say

Send text message in the channel

say(text: String)

Parameters

text (String) Message text

CommandoConstants

Type: Object

Properties

GLOBAL_SETTINGS_KEY (String?) : Global settings key to save global bot preferences

GLOBAL_EMOTES_URL (String?) : Service url for Emotes service

BOT_TYPE_NORMAL (String?) : Normal bot type (user, not mod)

BOT_TYPE_NORMAL_MODDED (String?) : Normal bot type with mod (user, channel mod)

BOT_TYPE_KNOWN (String?) : Known bot

BOT_TYPE_VERIFIED (String?) : Verified bot

MESSAGE_LIMITS (String?) : Enumeration for message limits configuration

ClientOptions

Client configuration options

ClientOptions

Type: Object

Properties

verboseLogging (Boolean) : Enable verbose logging (default: false)

username (String) : Bot username

oauth (String) : Bot oauth password (without oauth:)

botOwners (Array<String>) : List of bot owners username (default: empty array)

prefix (String) : Default command prefix (default: !)

greetOnJoin (Boolean) : Denotes if the bot must send a message when join a channel (default: false)

channels (Array<String>) : Initials channels to join (default: empty array)

onJoinMessage (String) : On Join message (sent if greetOnJoin = true)

autoJoinBotChannel (Boolean) : Denotes if the bot must autojoin its own channel (default: true)

enableJoinCommand (Boolean) : Denotes if enable the !join and !part command in bot channel (default: true)

botType (String) : Define the bot type, will be used for message limits control. See CommandoConstants for available bot type values (default: BOT_TYPE_NORMAL)

enableRateLimitingControl (Boolean) : Enable Rate Limiting control (default: true)

skipMembership (Boolean) : Skip PART\JOIN events (default: true)

enableVerboseLogging (Boolean) : Enable Verbose Logging up to debug level (default: false)

joinInterval (Number) : TMI Join Interval in milliseconds (default: 350ms instead of default tmi 2000ms)

TwitchCommandoClient

The Commando Client class

new TwitchCommandoClient(options: ClientOptions)

Extends EventEmitter

Parameters

options (ClientOptions) Client configuration options

Static Members

▸ enableVerboseLogging()

Enable verbose logging

enableVerboseLogging()

▸ connect()

Connect the bot to Twitch Chat

connect()

▸ say(channel, message, addRandomEmote)

Send a text message in the channel

say(channel: String, message: String, addRandomEmote: Boolean)

Parameters

channel (String) Channel destination

message (String) Message text

addRandomEmote

(Boolean
            = false)

Add random emote to avoid message duplication

▸ action(channel, message, addRandomEmote)

Send an action message in the channel

action(channel: String, message: String, addRandomEmote: Boolean): String

Parameters

channel (String)

message (String)

addRandomEmote

(Boolean
            = false)

Add random emote to avoid message duplication

Returns

String:

▸ whisper(username, message)

Send a private message to the user with given text

whisper(username: String, message: String): any

Parameters

username (String)

message (String)

Returns

any:

▸ registerCommandsIn(path)

registerCommandsIn(path: String)

Parameters

path (String)

▸ registerDetaultCommands()

registerDetaultCommands()

▸ setProvider(provider)

Set Settings Provider class

setProvider(provider: any)

Parameters

provider (any)

▸ join(channel)

Request the bot to join a channel

join(channel: String): Promise<String>

Parameters

channel (String) Channel to join

Returns

Promise<String>:

▸ part(channel)

Request the bot to leave a channel

part(channel: String): Promise<String>

Parameters

channel (String) Channel to leave

Returns

Promise<String>:

▸ getUsername()

Gets the bot username

getUsername(): String

Returns

String:

▸ getChannels()

Gets the bot channels

getChannels(): Array<String>

Returns

Array<String>:

▸ isOwner(author)

Checks if the message author is one of bot owners

isOwner(author: TwitchChatUser): Boolean

Parameters

author (TwitchChatUser) Message author

Returns

Boolean:

Events

▸ TwitchCommandoClient#connected

Bot connected

TwitchCommandoClient#connected

▸ TwitchCommandoClient#join

Channel joined or someone join the channel

TwitchCommandoClient#join

▸ TwitchCommandoClient#disconnected

Bot disonnects

TwitchCommandoClient#disconnected

▸ TwitchCommandoClient#message

Message received

TwitchCommandoClient#message

▸ TwitchCommandoClient#commandExecuted

Command executed

TwitchCommandoClient#commandExecuted

▸ TwitchCommandoClient#commandError

Command error

TwitchCommandoClient#commandError

▸ TwitchCommandoClient#timeout

Connection timeout

TwitchCommandoClient#timeout

▸ TwitchCommandoClient#reconnect

Reconnection

TwitchCommandoClient#reconnect

CommandArgument

Command argument

CommandArgument

Type: Object

Properties

name (String) : Argument key name

type (Object) : Argument type

defaultValue (Object) : Argument default value

CommandOptions

Command Options

CommandOptions

Type: Object

Properties

name (String) : Command name

modOnly (Boolean) : Restricted only to channel mods

ownerOnly (Boolean) : Restricted only to bot owners

broadcasterOnly (Boolean) : Restricted only to channel owner

description (String) : Command description

examples (Array<String>) : Command examples

args (Array<CommandArgument>) : Arguments

group (String) : Command group

aliases (Array<String>) : Command aliases

botChannelOnly (Boolean) : Restricted to bot channel only

hideFromHelp (Boolean) : Hide the command from help command

privmsgOnly (Boolean) : Restricted to privmsg only

TwichChatCommand

Base class to implement custom commands

new TwichChatCommand(client: TwitchCommandoClient, options: CommandOptions)

Parameters

client (TwitchCommandoClient) The TwitchCommandoClient

options (CommandOptions) Command options

Static Members

▸ run(msg, parameters)

Method called when command is executed

run(msg: TwitchChatMessage, parameters: object)

Parameters

msg (TwitchChatMessage) Message received

parameters (object) Arguments parsed

TwitchChatMessage

This class represents the chat message

new TwitchChatMessage(originalMessage: object, channel: String, client: TwitchCommandoClient)

Parameters

originalMessage (object)

channel (String)

client (TwitchCommandoClient)

Static Members

▸ text

Text of the message

text

Returns

String:

▸ author

The author of the message

author

Returns

TwitchChatUser:

▸ id

The ID of the message

Returns

String:

▸ channel

The channel where the message has been sent in

channel

Returns

TwitchChatChannel:

▸ color

Text color

color

Returns

String:

▸ emotes

Emotes contained in the message

emotes

▸ timestamp

Message sent date

timestamp

Returns

Date:

▸ messageType

Message type

messageType

Returns

String:

▸ reply(text, addRamndomEmote, addRandomEmote)

Helper method to reply quickly to a message. Create a message to send in the channel with @author

reply(text: String, addRamndomEmote: any, addRandomEmote: Boolean)

Parameters

text (String)

addRamndomEmote

(any
            = false)

addRandomEmote (Boolean) Add random emote to avoid message duplication

▸ actionReply(text, addRamndomEmote, addRandomEmote)

Helper method to reply quickly to a message with an action

actionReply(text: String, addRamndomEmote: any, addRandomEmote: Boolean)

Parameters

text (String)

addRamndomEmote

(any
            = false)

addRandomEmote (Boolean) Add random emote to avoid message duplication

TwitchChatUser

This class represents a chat user

new TwitchChatUser(originalMessage: Object, client: TwitchCommandoClient)

Parameters

originalMessage (Object)

client (TwitchCommandoClient)

Static Members

▸ name

name

▸ username

username

▸ mod

mod

▸ badges

badges

▸ subscriber

subscriber

▸ id

▸ userType

userType

▸ turbo

turbo

▸ whisper(message)

Whisper a message to the user

whisper(message: String)

Parameters

message (String) Message Text

▸ channel

Get the user channel

channel

Returns

String: Channel name

▸ isBroadcaster

Check if user is the channel broadcaster

isBroadcaster

Returns

Boolean: True if the user is the broadcaster