Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

Hierarchy

Index

Interfaces

Type aliases

Constructors

Properties

Methods

Type aliases

Static ArgumentMap

ArgumentMap<T>: {}

Type parameters

  • T: object

Type declaration

Static EventArgs

EventArgs<T, K>: Parameters<EventListener<T, K>>

Type parameters

Static EventListener

EventListener<T, K>: T extends string | symbol ? (...args: any[]) => void : (...args: ArgumentMap<Exclude<T, string | symbol>>[Extract<K, keyof T>]) => void

Type parameters

Static EventNames

EventNames<T>: T extends string | symbol ? T : keyof T

Type parameters

Static ValidEventTypes

ValidEventTypes: string | symbol | object

object should be in either of the following forms:

interface EventTypes {
  'event-with-parameters': any[]
  'event-with-example-handler': (...args: any[]) => void
}

Constructors

constructor

Properties

Private _clientPriority

_clientPriority: number = 100

Private Optional _heartbeatTimeoutId

_heartbeatTimeoutId: NodeJS.Timeout

Private _log

_log: Logger

Private Optional _moderatorQueue

_moderatorQueue: Queue

Private _options

_options: ClientOptions

Private _queue

_queue: Queue

Private _queueAuthenticate

_queueAuthenticate: Queue

Private _queueJoin

_queueJoin: Queue

Private Optional _reconnectTimeoutId

_reconnectTimeoutId: NodeJS.Timeout

Private _ws

_ws: WebSocket

Static EventEmitter

EventEmitter: EventEmitterStatic

Static prefixed

prefixed: string | boolean

Methods

Private _handleClose

  • _handleClose(_closeEvent: CloseEvent): void

  • Parameters

    • _closeEvent: CloseEvent

    Returns void

Private _handleError

  • _handleError(errorEvent: ErrorEvent): void

  • Parameters

    • errorEvent: ErrorEvent

    Returns void

Private _handleHeartbeat

  • _handleHeartbeat(): void

  • Returns void

Private _handleHeartbeatReset

  • _handleHeartbeatReset(): void

  • Returns void

Private _handleMessage

  • _handleMessage(messageEvent: MessageEvent): void

  • Parameters

    • messageEvent: MessageEvent

    Returns void

Private _handleOpen

  • _handleOpen(): void

  • Returns void

Private _multiEmit

addListener

disconnect

  • disconnect(): void

  • Returns void

emit

  • emit<T>(event: T, ...args: EventEmitter.EventArgs<ClientEventTypes & {}, T>): boolean

  • Calls each of the listeners registered for a given event.

    Type parameters

    Parameters

    Returns boolean

eventNames

  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<EventEmitter.EventNames<ClientEventTypes & {}>>

isReady

  • isReady(): boolean

  • Returns boolean

listenerCount

  • Return the number of listeners listening to a given event.

    Parameters

    Returns number

listeners

  • listeners<T>(event: T): Array<EventEmitter.EventListener<ClientEventTypes & {}, T>>

  • Return the listeners registered for a given event.

    Type parameters

    Parameters

    • event: T

    Returns Array<EventEmitter.EventListener<ClientEventTypes & {}, T>>

off

  • off<T>(event: T, fn?: EventEmitter.EventListener<ClientEventTypes & {}, T>, context?: Context, once?: undefined | false | true): this

  • Type parameters

    Parameters

    • event: T
    • Optional fn: EventEmitter.EventListener<ClientEventTypes & {}, T>
    • Optional context: Context
    • Optional once: undefined | false | true

    Returns this

on

  • Add a listener for a given event.

    Type parameters

    Parameters

    Returns this

once

  • Add a one-time listener for a given event.

    Type parameters

    Parameters

    Returns this

removeAllListeners

  • removeAllListeners(event?: EventEmitter.EventNames<ClientEventTypes & {}>): this

  • Remove all listeners, or those of the specified event.

    Parameters

    Returns this

removeListener

  • removeListener<T>(event: T, fn?: EventEmitter.EventListener<ClientEventTypes & {}, T>, context?: Context, once?: undefined | false | true): this

  • Remove the listeners of a given event.

    Type parameters

    Parameters

    • event: T
    • Optional fn: EventEmitter.EventListener<ClientEventTypes & {}, T>
    • Optional context: Context
    • Optional once: undefined | false | true

    Returns this

send

  • send(message: string, options?: Partial<{ isModerator: boolean; priority: number }>): Promise<void>

  • Send message to Twitch

    Parameters

    • message: string
    • Optional options: Partial<{ isModerator: boolean; priority: number }>

    Returns Promise<void>

Generated using TypeDoc