UserStateTracker | @kararty/dank-twitch-irc

Tracks the state of the logged in user (the bot) in all channels the bot operates in

Hierarchy

EventEmitter<UserStateTrackerEvents>
- UserStateTracker

Implements

ClientMixin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserStateTracker(client: ChatClient): UserStateTracker

Overrides EventEmitter<UserStateTrackerEvents>.constructor
- Defined in lib/mixins/userstate-tracker.ts:27
Parameters
- client: ChatClient
Returns UserStateTracker

Properties

channelStates

channelStates: Record<string, UserState> = {}

Optional globalState

globalState?: GlobalUserState

Methods

addListener

addListener<T>(event: T, fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void, context?: any): UserStateTracker

Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45
Type parameters
- T: keyof UserStateTrackerEvents
Parameters
- event: T
- fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void
  - - (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]): void
    - Parameters
      - Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]
      Returns void
- Optional context: any
Returns UserStateTracker

applyToClient

applyToClient(client: ChatClient): void

Implementation of ClientMixin.applyToClient
- Defined in lib/mixins/userstate-tracker.ts:40
Parameters
- client: ChatClient
Returns void

emit

emit<T>(event: T, ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32
Calls each of the listeners registered for a given event.

Type parameters
- T: keyof UserStateTrackerEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]
Returns boolean

eventNames

eventNames(): keyof UserStateTrackerEvents[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.

Returns keyof UserStateTrackerEvents[]

getChannelState

getChannelState(channelName: string): undefined | UserState

- Defined in lib/mixins/userstate-tracker.ts:32
Parameters
- channelName: string
Returns undefined | UserState

getGlobalState

getGlobalState(): undefined | GlobalUserState

- Defined in lib/mixins/userstate-tracker.ts:36
Returns undefined | GlobalUserState

listenerCount

listenerCount(event: keyof UserStateTrackerEvents): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27
Return the number of listeners listening to a given event.

Parameters
- event: keyof UserStateTrackerEvents
Returns number

listeners

listeners<T>(event: T): ((...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void)[]

Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20
Return the listeners registered for a given event.

Type parameters
- T: keyof UserStateTrackerEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void)[]

off

off<T>(event: T, fn?: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void, context?: any, once?: boolean): UserStateTracker

Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69
Type parameters
- T: keyof UserStateTrackerEvents
Parameters
- event: T
- Optional fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void
  - - (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]): void
    - Parameters
      - Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns UserStateTracker

on

on<T>(event: T, fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void, context?: any): UserStateTracker

Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40
Add a listener for a given event.

Type parameters
- T: keyof UserStateTrackerEvents
Parameters
- event: T
- fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void
  - - (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]): void
    - Parameters
      - Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]
      Returns void
- Optional context: any
Returns UserStateTracker

once

once<T>(event: T, fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void, context?: any): UserStateTracker

Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54
Add a one-time listener for a given event.

Type parameters
- T: keyof UserStateTrackerEvents
Parameters
- event: T
- fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void
  - - (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]): void
    - Parameters
      - Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]
      Returns void
- Optional context: any
Returns UserStateTracker

removeAllListeners

removeAllListeners(event?: keyof UserStateTrackerEvents): UserStateTracker

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79
Remove all listeners, or those of the specified event.

Parameters
- Optional event: keyof UserStateTrackerEvents
Returns UserStateTracker

removeListener

removeListener<T>(event: T, fn?: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void, context?: any, once?: boolean): UserStateTracker

Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63
Remove the listeners of a given event.

Type parameters
- T: keyof UserStateTrackerEvents
Parameters
- event: T
- Optional fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void
  - - (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]): void
    - Parameters
      - Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns UserStateTracker

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: ChatClient

Returns UserStateTracker

Properties

channelStates

Optional globalState

Methods

addListener

Type parameters

T: keyof UserStateTrackerEvents

Parameters

event: T

fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void

Parameters

Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]

Returns void

Optional context: any

Returns UserStateTracker

applyToClient

Parameters

client: ChatClient

Returns void

emit

Type parameters

T: keyof UserStateTrackerEvents

Parameters

event: T

Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]

Returns boolean

eventNames

Returns keyof UserStateTrackerEvents[]

getChannelState

Parameters

channelName: string

Returns undefined | UserState

getGlobalState

Returns undefined | GlobalUserState

listenerCount

Parameters

event: keyof UserStateTrackerEvents

Returns number

listeners

Type parameters

T: keyof UserStateTrackerEvents

Parameters

event: T

Returns ((...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void)[]

off

Type parameters

T: keyof UserStateTrackerEvents

Parameters

event: T

Optional fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void

Parameters

Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]

Returns void

Optional context: any

Optional once: boolean

Returns UserStateTracker

on

Type parameters

T: keyof UserStateTrackerEvents

Parameters

event: T

fn: (...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]) => void

Parameters

Rest ...args: ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]

Returns void

Optional context: any

Returns UserStateTracker

once

Type parameters