Options
All
  • Public
  • Public/Protected
  • All
Menu

TwitchJS

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ApiFetchOptions

ApiFetchOptions: FetchOptions

ApiOptions

ApiOptions: { clientId: string; log?: LoggerOptions; onAuthenticationFailure?: undefined | (() => Promise<string>); token: string }

Type declaration

  • clientId: string
  • Optional log?: LoggerOptions
  • Optional onAuthenticationFailure?: undefined | (() => Promise<string>)
  • token: string

ApiValidateResponse

ApiValidateResponse: { client_id: string; expires_in: number; login: string; scopes: string[]; user_id: string }

Validate response

see

https://dev.twitch.tv/docs/authentication#validating-requests

Type declaration

  • client_id: string
  • expires_in: number
  • login: string
  • scopes: string[]
  • user_id: string

Badges

Badges: { admin: boolean; bits: number; bitsLeader: number; broadcaster: boolean; globalMod: boolean; moderator: boolean; partner: boolean; premium: boolean; staff: boolean; subGifter: boolean; subscriber: number; turbo: boolean; vip: boolean } | {}

BaseTwitchJsOptions

BaseTwitchJsOptions: { clientId?: undefined | string; log?: LoggerOptions; onAuthenticationFailure?: undefined | (() => Promise<string>); token?: undefined | string; username?: undefined | string }

Type declaration

  • Optional clientId?: undefined | string
  • Optional log?: LoggerOptions
  • Optional onAuthenticationFailure?: undefined | (() => Promise<string>)
  • Optional token?: undefined | string
  • Optional username?: undefined | string

ChannelState

ChannelState: { roomState: RoomStateTags; userState?: UserStateTags }

Type declaration

ChannelStates

ChannelStates: Record<string, ChannelState>

ChatOptions

ChatOptions: { connectionTimeout: number; isKnown?: undefined | false | true; isVerified?: undefined | false | true; joinTimeout: number; log?: LoggerOptions; onAuthenticationFailure?: undefined | (() => Promise<string>); token?: undefined | string; username?: undefined | string }

Type declaration

ClearChatMessages

ClearChatMessages: ClearChatMessage | ClearChatUserBannedMessage

ClientEventTypes

ClientEventTypes: { [ClientEvents.ALL]: [BaseMessage]; [ClientEvents.AUTHENTICATED]: [BaseMessage]; [ClientEvents.AUTHENTICATION_FAILED]: [BaseMessage]; [ClientEvents.CONNECTED]: [BaseMessage]; [ClientEvents.DISCONNECTED]: []; [ClientEvents.ERROR_ENCOUNTERED]: [Error]; [ClientEvents.RAW]: [string]; [ClientEvents.RECONNECT]: [] }

Type declaration

  • [ClientEvents.ALL]: [BaseMessage]
  • [ClientEvents.AUTHENTICATED]: [BaseMessage]
  • [ClientEvents.AUTHENTICATION_FAILED]: [BaseMessage]
  • [ClientEvents.CONNECTED]: [BaseMessage]
  • [ClientEvents.DISCONNECTED]: []
  • [ClientEvents.ERROR_ENCOUNTERED]: [Error]
  • [ClientEvents.RAW]: [string]
  • [ClientEvents.RECONNECT]: []

ClientEvents

ClientEvents: Commands | BaseClientEvents

ClientOptions

ClientOptions: { isKnown: boolean; isVerified: boolean; log?: LoggerOptions; port: number; server: string; ssl: boolean; token?: undefined | string; username?: undefined | string }

Type declaration

  • isKnown: boolean
  • isVerified: boolean
  • Optional log?: LoggerOptions
  • port: number
  • server: string
  • ssl: boolean
  • Optional token?: undefined | string
  • Optional username?: undefined | string

DistributeKeys

DistributeKeys<T>: {}

Type parameters

  • T

Type declaration

EmoteTag

EmoteTag: { end: number; id: string; start: number }

Type declaration

  • end: number
  • id: string
  • start: number

EventTypes

EventTypes: Omit<ClientEventTypes, ALL> & { [Events.ALL]: [Messages]; [Events.ALREADY_BANNED]: [NoticeMessage]; [Events.ALREADY_EMOTE_ONLY_OFF]: [NoticeMessage]; [Events.ALREADY_EMOTE_ONLY_ON]: [NoticeMessage]; [Events.ALREADY_R9K_OFF]: [NoticeMessage]; [Events.ALREADY_R9K_ON]: [NoticeMessage]; [Events.ALREADY_SUBS_OFF]: [NoticeMessage]; [Events.ALREADY_SUBS_ON]: [NoticeMessage]; [Events.ANON_GIFT_PAID_UPGRADE]: [UserNoticeAnonymousGiftPaidUpgradeMessage]; [Events.BAD_HOST_HOSTING]: [NoticeMessage]; [Events.BAD_MOD_MOD]: [NoticeMessage]; [Events.BAD_UNBAN_NO_BAN]: [NoticeMessage]; [Events.BAN_SUCCESS]: [NoticeMessage]; [Events.CHEER]: [PrivateMessageWithBits]; [Events.CLEAR_CHAT]: [ClearChatMessages]; [Events.CMDS_AVAILABLE]: [NoticeMessage]; [Events.COLOR_CHANGED]: [NoticeMessage]; [Events.COMMERCIAL_SUCCESS]: [NoticeMessage]; [Events.EMOTE_ONLY_OFF]: [NoticeMessage]; [Events.EMOTE_ONLY_ON]: [NoticeMessage]; [Events.FOLLOWERS_OFF]: [NoticeMessage]; [Events.FOLLOWERS_ONZERO]: [NoticeMessage]; [Events.FOLLOWERS_ON]: [NoticeMessage]; [Events.GIFT_PAID_UPGRADE]: [UserNoticeGiftPaidUpgradeMessage]; [Events.HOSTED_AUTO]: [HostingAutoPrivateMessage]; [Events.HOSTED_WITHOUT_VIEWERS]: [HostingPrivateMessage]; [Events.HOSTED_WITH_VIEWERS]: [HostingWithViewersPrivateMessage]; [Events.HOSTS_REMAINING]: [NoticeMessage]; [Events.HOST_OFF]: [NoticeMessage]; [Events.HOST_ON]: [NoticeMessage]; [Events.HOST_TARGET]: [HostTargetMessage]; [Events.JOIN]: [JoinMessage]; [Events.MODE]: [ModeMessages]; [Events.MOD_SUCCESS]: [NoticeMessage]; [Events.MSG_CHANNEL_SUSPENDED]: [NoticeMessage]; [Events.NAMES]: [NamesMessage]; [Events.NAMES_END]: [NamesEndMessage]; [Events.NOTICE]: [NoticeMessages]; [Events.PART]: [PartMessage]; [Events.PRIVATE_MESSAGE]: [PrivateMessages]; [Events.R9K_OFF]: [NoticeMessage]; [Events.R9K_ON]: [NoticeMessage]; [Events.RAID]: [UserNoticeRaidMessage]; [Events.RESUBSCRIPTION]: [UserNoticeResubscriptionMessage]; [Events.RITUAL]: [UserNoticeRitualMessage]; [Events.ROOM_MODS]: [NoticeRoomModsMessage]; [Events.ROOM_STATE]: [RoomStateMessage]; [Events.SLOW_OFF]: [NoticeMessage]; [Events.SLOW_ON]: [NoticeMessage]; [Events.SUBSCRIPTION]: [UserNoticeSubscriptionMessage]; [Events.SUBSCRIPTION_GIFT]: [UserNoticeSubscriptionGiftMessage]; [Events.SUBSCRIPTION_GIFT_COMMUNITY]: [UserNoticeSubscriptionGiftCommunityMessage]; [Events.SUBS_OFF]: [NoticeMessage]; [Events.SUBS_ON]: [NoticeMessage]; [Events.TIMEOUT_SUCCESS]: [NoticeMessage]; [Events.UNBAN_SUCCESS]: [NoticeMessage]; [Events.UNRAID_SUCCESS]: [NoticeMessage]; [Events.UNRECOGNIZED_CMD]: [NoticeMessage]; [Events.USER_NOTICE]: [UserNoticeMessages]; [Events.USER_STATE]: [UserStateMessage]; [NoticeCompounds.ALREADY_BANNED]: [NoticeMessage]; [NoticeCompounds.ALREADY_EMOTE_ONLY_OFF]: [NoticeMessage]; [NoticeCompounds.ALREADY_EMOTE_ONLY_ON]: [NoticeMessage]; [NoticeCompounds.ALREADY_R9K_OFF]: [NoticeMessage]; [NoticeCompounds.ALREADY_R9K_ON]: [NoticeMessage]; [NoticeCompounds.ALREADY_SUBS_OFF]: [NoticeMessage]; [NoticeCompounds.ALREADY_SUBS_ON]: [NoticeMessage]; [NoticeCompounds.BAD_HOST_HOSTING]: [NoticeMessage]; [NoticeCompounds.BAD_MOD_MOD]: [NoticeMessage]; [NoticeCompounds.BAD_UNBAN_NO_BAN]: [NoticeMessage]; [NoticeCompounds.BAN_SUCCESS]: [NoticeMessage]; [NoticeCompounds.CMDS_AVAILABLE]: [NoticeMessage]; [NoticeCompounds.COLOR_CHANGED]: [NoticeMessage]; [NoticeCompounds.COMMERCIAL_SUCCESS]: [NoticeMessage]; [NoticeCompounds.EMOTE_ONLY_OFF]: [NoticeMessage]; [NoticeCompounds.EMOTE_ONLY_ON]: [NoticeMessage]; [NoticeCompounds.FOLLOWERS_OFF]: [NoticeMessage]; [NoticeCompounds.FOLLOWERS_ONZERO]: [NoticeMessage]; [NoticeCompounds.FOLLOWERS_ON]: [NoticeMessage]; [NoticeCompounds.HOSTS_REMAINING]: [NoticeMessage]; [NoticeCompounds.HOST_OFF]: [NoticeMessage]; [NoticeCompounds.HOST_ON]: [NoticeMessage]; [NoticeCompounds.MOD_SUCCESS]: [NoticeMessage]; [NoticeCompounds.MSG_CHANNEL_SUSPENDED]: [NoticeMessage]; [NoticeCompounds.R9K_OFF]: [NoticeMessage]; [NoticeCompounds.R9K_ON]: [NoticeMessage]; [NoticeCompounds.ROOM_MODS]: [NoticeRoomModsMessage]; [NoticeCompounds.SLOW_OFF]: [NoticeMessage]; [NoticeCompounds.SLOW_ON]: [NoticeMessage]; [NoticeCompounds.SUBS_OFF]: [NoticeMessage]; [NoticeCompounds.SUBS_ON]: [NoticeMessage]; [NoticeCompounds.TIMEOUT_SUCCESS]: [NoticeMessage]; [NoticeCompounds.UNBAN_SUCCESS]: [NoticeMessage]; [NoticeCompounds.UNRAID_SUCCESS]: [NoticeMessage]; [NoticeCompounds.UNRECOGNIZED_CMD]: [NoticeMessage]; [PrivateMessageCompounds.CHEER]: [PrivateMessageWithBits]; [PrivateMessageCompounds.HOSTED_AUTO]: [HostingAutoPrivateMessage]; [PrivateMessageCompounds.HOSTED_WITHOUT_VIEWERS]: [HostingPrivateMessage]; [PrivateMessageCompounds.HOSTED_WITH_VIEWERS]: [HostingWithViewersPrivateMessage]; [UserNoticeCompounds.ANON_GIFT_PAID_UPGRADE]: [UserNoticeAnonymousGiftPaidUpgradeMessage]; [UserNoticeCompounds.GIFT_PAID_UPGRADE]: [UserNoticeGiftPaidUpgradeMessage]; [UserNoticeCompounds.RAID]: [UserNoticeRaidMessage]; [UserNoticeCompounds.RESUBSCRIPTION]: [UserNoticeResubscriptionMessage]; [UserNoticeCompounds.RITUAL]: [UserNoticeRitualMessage]; [UserNoticeCompounds.SUBSCRIPTION]: [UserNoticeSubscriptionMessage]; [UserNoticeCompounds.SUBSCRIPTION_GIFT]: [UserNoticeSubscriptionGiftMessage]; [UserNoticeCompounds.SUBSCRIPTION_GIFT_COMMUNITY]: [UserNoticeSubscriptionGiftCommunityMessage] }

Events

Events: keyof DistributeKeys<typeof Events>

FetchOptions

FetchOptions<Query, Body>: Omit<RequestInit, "body"> & { search?: Query } & { body?: Body }

Type parameters

  • Query = QueryParams

  • Body = BodyParams

IndividualClassOptions

IndividualClassOptions: { api?: ApiOptions; chat?: ChatOptions }

Type declaration

Logger

Logger: ReturnType<typeof createLogger>

LoggerOptions

LoggerOptions: PinoLoggerOptions
see

https://github.com/pinojs/pino/blob/v6.3.1/docs/api.md#options

Messages

Messages: BaseMessage | JoinMessage | PartMessage | ModeMessages | NamesMessage | NamesEndMessage | GlobalUserStateMessage | ClearChatMessages | ClearMessageMessage | HostTargetMessage | RoomStateMessage | NoticeMessages | UserStateMessage | PrivateMessages | UserNoticeMessages

ModeMessages

ModeMessages: ModeModGainedMessage | ModeModLostMessage

NoticeEvents

NoticeEvents: keyof typeof NoticeEvents

NoticeMessages

NoticeMessages: NoticeMessage | NoticeRoomModsMessage

NOTICE message

see

https://dev.twitch.tv/docs/irc/commands/#msg-id-tags-for-the-notice-commands-capability

PrivateMessages

PrivateMessages: PrivateMessage | PrivateMessageWithBits | HostingPrivateMessage | HostingWithViewersPrivateMessage | HostingAutoPrivateMessage

QueryParams

QueryParams: {}

Type declaration

  • [key: string]: string | number | boolean

    Any query parameters you want to add to your request.

Tags

Tags: ClearChatTags | GlobalUserStateTags | RoomStateTags | UserStateTags | PrivateMessageTags | NoticeTags | UserNoticeTags

TwitchJsOptions

TwitchJsOptions: BaseTwitchJsOptions & IndividualClassOptions

UserNoticeEvents

UserNoticeEvents: keyof typeof UserNoticeEvents

UserNoticeMessageParameters

UserNoticeMessageParameters: AnonymousGiftPaidUpgradeParameters | GiftPaidUpgradeParameters | RaidParameters | ResubscriptionParameters | RitualParameters | SubscriptionGiftCommunityParameters | SubscriptionGiftParameters | SubscriptionParameters

UserNoticeMessages

UserNoticeMessages: UserNoticeAnonymousGiftPaidUpgradeMessage | UserNoticeGiftPaidUpgradeMessage | UserNoticeRaidMessage | UserNoticeResubscriptionMessage | UserNoticeRitualMessage | UserNoticeSubscriptionGiftCommunityMessage | UserNoticeSubscriptionGiftMessage | UserNoticeSubscriptionMessage

Variables

Const ANONYMOUS_USERNAME

ANONYMOUS_USERNAME: "justinfan" = "justinfan"

Const ANONYMOUS_USERNAME_RE

ANONYMOUS_USERNAME_RE: RegExp = new RegExp(`^${ANONYMOUS_USERNAME}(\\d+)$`)

Const CHAT_SERVER

CHAT_SERVER: "irc-ws.chat.twitch.tv" = "irc-ws.chat.twitch.tv"

Const CHAT_SERVER_PORT

CHAT_SERVER_PORT: 6667 = 6667

Const CHAT_SERVER_SSL_PORT

CHAT_SERVER_SSL_PORT: 443 = 443

Const CLIENT_PRIORITY

CLIENT_PRIORITY: 100 = 100

Const COMMAND_TIMEOUT

COMMAND_TIMEOUT: 1000 = 1000

Const CONNECT

CONNECT: unique symbol = Symbol('connect')

Const CONNECTED

CONNECTED: unique symbol = Symbol('connected')

Const CONNECTION_TIMEOUT

CONNECTION_TIMEOUT: 5000 = 5000

Const DISCONNECT

DISCONNECT: unique symbol = Symbol('disconnect')

Const DISCONNECTED

DISCONNECTED: unique symbol = Symbol('disconnected')

Const ERROR_COMMAND_TIMED_OUT

ERROR_COMMAND_TIMED_OUT: "ERROR: command timed out" = "ERROR: command timed out"

Const ERROR_COMMAND_UNRECOGNIZED

ERROR_COMMAND_UNRECOGNIZED: "ERROR: command unrecognized" = "ERROR: command unrecognized"

Const ERROR_CONNECTION_IN_PROGRESS

ERROR_CONNECTION_IN_PROGRESS: "ERROR: connection in progress" = "ERROR: connection in progress"

Const ERROR_CONNECT_TIMED_OUT

ERROR_CONNECT_TIMED_OUT: "ERROR: connect timed out" = "ERROR: connect timed out"

Const ERROR_JOIN_TIMED_OUT

ERROR_JOIN_TIMED_OUT: "ERROR: join timed out" = "ERROR: join timed out"

Const ERROR_PART_TIMED_OUT

ERROR_PART_TIMED_OUT: "ERROR: part timed out" = "ERROR: part timed out"

Const ERROR_SAY_TIMED_OUT

ERROR_SAY_TIMED_OUT: "ERROR: say timed out" = "ERROR: say timed out"

Const JOIN_TIMEOUT

JOIN_TIMEOUT: 1000 = 1000

Const KEEP_ALIVE_PING_TIMEOUT

KEEP_ALIVE_PING_TIMEOUT: 150000 = 150000

Const KEEP_ALIVE_RECONNECT_TIMEOUT

KEEP_ALIVE_RECONNECT_TIMEOUT: 200000 = 200000

Const KnownNoticeMessageIdsUpperCase

KnownNoticeMessageIdsUpperCase: Record<"ALREADY_BANNED" | "ALREADY_EMOTE_ONLY_OFF" | "ALREADY_EMOTE_ONLY_ON" | "ALREADY_R9K_OFF" | "ALREADY_R9K_ON" | "ALREADY_SUBS_OFF" | "ALREADY_SUBS_ON" | "BAD_HOST_HOSTING" | "BAD_MOD_MOD" | "BAN_SUCCESS" | "BAD_UNBAN_NO_BAN" | "COLOR_CHANGED" | "CMDS_AVAILABLE" | "COMMERCIAL_SUCCESS" | "EMOTE_ONLY_OFF" | "EMOTE_ONLY_ON" | "FOLLOWERS_OFF" | "FOLLOWERS_ON" | "FOLLOWERS_ONZERO" | "HOST_OFF" | "HOST_ON" | "HOSTS_REMAINING" | "MSG_CHANNEL_SUSPENDED" | "MOD_SUCCESS" | "NOT_HOSTING" | "R9K_OFF" | "R9K_ON" | "ROOM_MODS" | "SLOW_OFF" | "SLOW_ON" | "SUBS_OFF" | "SUBS_ON" | "TIMEOUT_SUCCESS" | "UNBAN_SUCCESS" | "UNMOD_SUCCESS" | "UNRAID_SUCCESS" | "UNRECOGNIZED_CMD", string> = Object.entries(KnownNoticeMessageIds,).reduce((uppercase, [key, value]) => ({ ...uppercase, [key]: value.toUpperCase() }),{} as Record<keyof typeof KnownNoticeMessageIds, string>,)

Const MESSAGE_PARAMETER_PREFIX

MESSAGE_PARAMETER_PREFIX: "msgParam" = "msgParam"

Const MESSAGE_PARAMETER_PREFIX_RE

MESSAGE_PARAMETER_PREFIX_RE: RegExp = new RegExp(`^${MESSAGE_PARAMETER_PREFIX}(\\w+)`,)

Const NoticeEvents

NoticeEvents: DistributeKeys<KnownNoticeMessageIds> = Object.keys(KnownNoticeMessageIds).reduce((events, event) => ({...events,[event]: event,[`${Commands.NOTICE}/${event.toUpperCase()}`]: event,}),{} as DistributeKeys<typeof KnownNoticeMessageIds>,)

Const PRIVATE_MESSAGE_HOSTED_RE

PRIVATE_MESSAGE_HOSTED_RE: RegExp = /:.+@jtv\.tmi\.twitch\.tv PRIVMSG #?(\w+) :(\w+) is now (?:(auto) )?hosting[A-z ]+(\d+)?/

Const RATE_LIMIT_KNOWN_BOT

RATE_LIMIT_KNOWN_BOT: 50 = 50

Const RATE_LIMIT_MODERATOR

RATE_LIMIT_MODERATOR: 100 = 100

Const RATE_LIMIT_USER

RATE_LIMIT_USER: 20 = 20

Const RATE_LIMIT_VERIFIED_BOT

RATE_LIMIT_VERIFIED_BOT: 7500 = 7500

Const RECONNECT

RECONNECT: unique symbol = Symbol('reconnect')

Const UserNoticeEvents

UserNoticeEvents: DistributeKeys<KnownUserNoticeMessageIds> = Object.keys(KnownUserNoticeMessageIds).reduce((events, event) => ({...events,[event]: event,[`${Commands.USER_NOTICE}/${event}`]: event,}),{} as DistributeKeys<typeof KnownUserNoticeMessageIds>,)

Const userNotice

userNotice: userState = userState

Functions

Const apiOptions

  • Parameters

    Returns ApiOptions

Const badges

  • badges(maybeBadges: string): Partial<Badges>

Const base

  • base(rawMessages: string, username?: string): BaseMessage[]

  • Parameters

    • rawMessages: string
    • Default value username: string = ""

    Returns BaseMessage[]

Const baseParser

  • baseParser(rawMessages: string, username?: string): BaseMessage[]

  • Parameters

    • rawMessages: string
    • Default value username: string = ""

    Returns BaseMessage[]

Const broadcasterLanguage

  • broadcasterLanguage(maybeLanguage: string): undefined | string

  • Parameters

    • maybeLanguage: string

    Returns undefined | string

Const channel

  • channel(value?: any): string
  • channel(channel: string): string

  • Parameters

    • Optional value: any

    Returns string

  • Parameters

    • channel: string

    Returns string

Const chatOptions

  • chatOptions(options: Partial<types.ChatOptions>): types.ChatOptions

  • Parameters

    • options: Partial<types.ChatOptions>

    Returns types.ChatOptions

Const clearChat

  • Parameters

    Returns ClearChatTags

Const clearChatMessage

Const clearMessageMessage

Const clientOptions

  • clientOptions(options: Partial<types.ClientOptions>): types.ClientOptions

  • Parameters

    • options: Partial<types.ClientOptions>

    Returns types.ClientOptions

Const createLogger

  • createLogger(options?: LoggerOptions): BaseLogger & {} & { profile: typeof profile }

  • Parameters

    • Default value options: LoggerOptions = {}

    Returns BaseLogger & {} & { profile: typeof profile }

Const emoteSets

  • emoteSets(maybeEmoteSets: string): string[]

  • Parameters

    • maybeEmoteSets: string

    Returns string[]

Const emotes

  • emotes(maybeEmotes: string): EmoteTag[]

Const fetchUtil

  • fetchUtil<Response, Query, Body>(url: RequestInfo, options?: FetchOptions<Query, Body>, qsOptions?: IStringifyOptions): Promise<Response>

  • Fetches URL

    Type parameters

    • Response = any

    • Query = QueryParams

    • Body = BodyParams

    Parameters

    • url: RequestInfo
    • Optional options: FetchOptions<Query, Body>
    • Optional qsOptions: IStringifyOptions

    Returns Promise<Response>

Const followersOnly

  • followersOnly(maybeFollowersOnly: string): number | false | true

  • Parameters

    • maybeFollowersOnly: string

    Returns number | false | true

Const generalBoolean

  • generalBoolean(maybeBoolean: string): boolean

  • Parameters

    • maybeBoolean: string

    Returns boolean

Const generalNumber

  • generalNumber(maybeNumber: string): undefined | number

  • Parameters

    • maybeNumber: string

    Returns undefined | number

Const generalString

  • generalString(maybeMessage: string): undefined | string

  • Parameters

    • maybeMessage: string

    Returns undefined | string

Const generalTimestamp

  • generalTimestamp(maybeTimestamp: string): Date
  • generalTimestamp(maybeTimestamp: string): Date

  • Parameters

    • maybeTimestamp: string

    Returns Date

  • Parameters

    • maybeTimestamp: string

    Returns Date

Const getEventNameFromMessage

  • getEventNameFromMessage(message: BaseMessage): string

  • Parameters

    Returns string

Const getJsonInit

  • getJsonInit(input?: any): { body?: string | FormData; headers?: HeadersInit }

  • Parameters

    • Optional input: any

    Returns { body?: string | FormData; headers?: HeadersInit }

    • Optional body?: string | FormData
    • Optional headers?: HeadersInit

Const globalUserState

Const globalUserStateMessage

Const hostTargetMessage

Const isAuthenticationFailedMessage

  • isAuthenticationFailedMessage(message?: BaseMessage): boolean
  • isAuthenticationFailedMessage(message?: BaseMessage): boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

Const isUserAnonymous

  • isUserAnonymous(value: string): boolean

  • Parameters

    • value: string

    Returns boolean

Const joinMessage

Const modeMessage

Const mods

  • mods(message: string): string[]

  • Parameters

    • message: string

    Returns string[]

Const namesEndMessage

Const namesMessage

Const noticeMessage

Const partMessage

Const privateMessage

  • PRIVMSG message When a user joins a channel or sends a PRIVMSG to a channel. When a user cheers a channel. When a user hosts your channel while connected as broadcaster.

    Parameters

    Returns PrivateMessages

Const privateMessageCheerEvent

  • Parameters

    Returns { bits: number; event: ChatEvents } | { event: Commands }

Const roomState

  • Parameters

    Returns RoomStateTags

Const roomStateMessage

  • When a user joins a channel or a room setting is changed.

    Parameters

    Returns RoomStateMessage

Const token

  • token(value: any): string
  • token(value: any): string

  • Parameters

    • value: any

    Returns string

  • Parameters

    • value: any

    Returns string

Const userNoticeMessage

Const userNoticeMessageParameters

Const userState

  • Parameters

    Returns UserStateTags

Const userStateMessage

  • USERSTATE message When a user joins a channel or sends a PRIVMSG to a channel.

    Parameters

    Returns UserStateMessage

Const userType

  • userType(maybeUserType: string): undefined | string

  • Parameters

    • maybeUserType: string

    Returns undefined | string

Const username

  • username(...maybeUsernames: any[]): string
  • username(value: any): string
  • username(...maybeUsernames: any[]): string
  • username(value: any): string

  • Parameters

    • Rest ...maybeUsernames: any[]

    Returns string

  • Parameters

    • value: any

    Returns string

  • Parameters

    • Rest ...maybeUsernames: any[]

    Returns string

  • Parameters

    • value: any

    Returns string

Object literals

Const ClientEvents

ClientEvents: object

Const Events

Events: object

Generated using TypeDoc