Class Client

constructor

• new Client(options: IClientOptions): Client

  Parameters

  • options: IClientOptions

  Returns Client

channels

isAnonymous

user

disconnect

• disconnect(): Promise<void>

  Disconnects from twitch server and stop the client

  Returns Promise<void>

getOptions

• getOptions(): IClientOptions

  Get the client options

  Returns IClientOptions

  [IClientOptions] - The client options

getRestManager

• getRestManager(): RestManager

  Get the REST API Manager Instance

  Returns RestManager

  [RestManager] - The REST API Manager Instance

getWebSocketManager

• getWebSocketManager(): WebSocketManager

  Get the WebSocket Manager Instance

  Returns WebSocketManager

  [WebSocketManager] - The WebSocket Manager Instance

isChannelLive

• isChannelLive(channel: string): Promise<boolean>

  Checks if a channel is currently in live

  Parameters

  • channel: string

    The channel name to check

  Returns Promise<boolean>

  • Returns true if the channel is live, false otherwise

  Throws

  • If the client is not ready or the channel name is invalid

  Throws

  • If the channel name includes spaces or starts with '#'

  Throws

  • If there is an error while checking the channel status

join

• join(channel: string): Promise<string>

  Connects with a twitch channel chat

  Parameters

  • channel: string

    The channel name who will be connected

  Returns Promise<string>

  • Resolved when successfully connect with channel

leave

• leave(channel: string): Promise<string>

  Disconnects from a twitch channel chat

  Parameters

  • channel: string

    The channel name who will be disconnected

  Returns Promise<string>

  • Resolved with channel name when successfully disconnect with channel

login

• login(token?: null | string): Promise<void>

  Starts the step manager and log in twitch.

  Parameters

  • token: null | string = null

    The token to use for the login

  Returns Promise<void>

multiJoin

• multiJoin(channels: string[]): Promise<string>

  Connects in multiples twitch channels chats

  Parameters

  • channels: string[]

    The array of channels to join

  Returns Promise<string>

  • Resolved when successfully connect with channel

ping

• ping(): Promise<number>

  Do a ping to twitch and returns the response time in milliseconds

  Returns Promise<number>

  • The twitch response time in milliseconds

uptime

• uptime(): number

  returns the client uptime in milliseconds

  Returns number

  the number of milliseconds since the client is ready

  Example

  const uptime = Client.uptime();
  Copy