Class ChannelStructure

constructor

• new ChannelStructure(client: Client, channelName: string): ChannelStructure

  Parameters

  • client: Client
  • channelName: string

  Returns ChannelStructure

connected

emoteOnly

followersCoolDown

followersOnly

id

name

r9k

rituals

self

slowCoolDown

slowMode

subsOnly

users

getUserCount

• getUserCount(): number

  Returns the amount of users in the channel

  Returns number

  The amount of users in the channel

  Example

  Client.channels.get('channel-id').getUserCount();
  Copy

isConnected

• isConnected(): boolean

  Returns if the bot is connected to the channel

  Returns boolean

  True if the bot is connected to the channel, false if not

  Example

  Client.channels.get('channel-id').isConnected();
  Copy

leave

• leave(): Promise<string>

  Leaves from the channel

  Returns Promise<string>

  • The channel name

send

• send(message: string, options: string | string[]): Promise<void>

  Sends a message to the channel

  Parameters

  • message: string

    The message to send
  • options: string | string[]

    The options to send the message with - Like a console.log()

  Returns Promise<void>

  Example

  Client.channels.get('channel-id').send('Hello World!');
  Copy