Client

Client, The Main hub point twitch API

Methods

login(username, password)

Connect to twitch

  • Parameters

    • username - accounts username (string)

    • password - accounts auth password (string)

password parameter is not your account. To get the correct Auth password, follow this link

Properties

Name

Type

Description

options

client options

reconnect

boolean

Whether or not to reconnect the client if gets disconnected

channels

Storage<string, Channel>

user

User that the client is logged in as

ready

boolean

whether or not the client is ready

currentLatency

number

Client ping rate

latency

Date

Respons latency

readyAt

number

The time the client was ready at

Events

Name

Parameters

Description

ready

none

connecting

none

disconnected

none

chat

message - Message

cheer

message - Message

joinRoom

room - Channel

leaveRoom

room - Channel

viewerBan

viewer - Viewer

viewerUnban

none

viewerTimeout

viewer - Viewer

warn

info - any

error

error - any

raw_message

message - Object

raw

info - string

Last updated

Was this helpful?