RoomStateTracker | @kararty/dank-twitch-irc

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

Hierarchy

EventEmitter<RoomStateTrackerEvents>
- RoomStateTracker

Implements

ClientMixin

Index

Constructors

constructor

Methods

Constructors

constructor

new RoomStateTracker(): RoomStateTracker

Inherited from EventEmitter<RoomStateTrackerEvents>.constructor
- Defined in node_modules/eventemitter3/index.d.ts:88
Returns RoomStateTracker

Methods

addListener

addListener<T>(event: T, fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void, context?: any): RoomStateTracker

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

applyToClient

applyToClient(client: ChatClient): void

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

emit

emit<T>(event: T, ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]): 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: "newChannelState"
Parameters
- event: T
- Rest ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]
Returns boolean

eventNames

eventNames(): "newChannelState"[]

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 "newChannelState"[]

getChannelState

getChannelState(channelName: string): undefined | RoomState

- Defined in lib/mixins/roomstate-tracker.ts:26
Parameters
- channelName: string
Returns undefined | RoomState

listenerCount

listenerCount(event: "newChannelState"): 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: "newChannelState"
Returns number

listeners

listeners<T>(event: T): ((...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => 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: "newChannelState"
Parameters
- event: T
Returns ((...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void)[]

off

off<T>(event: T, fn?: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void, context?: any, once?: boolean): RoomStateTracker

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

on

on<T>(event: T, fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void, context?: any): RoomStateTracker

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

Type parameters
- T: "newChannelState"
Parameters
- event: T
- fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void
  - - (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]): void
    - Parameters
      - Rest ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]
      Returns void
- Optional context: any
Returns RoomStateTracker

once

once<T>(event: T, fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void, context?: any): RoomStateTracker

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: "newChannelState"
Parameters
- event: T
- fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void
  - - (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]): void
    - Parameters
      - Rest ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]
      Returns void
- Optional context: any
Returns RoomStateTracker

removeAllListeners

removeAllListeners(event?: "newChannelState"): RoomStateTracker

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: "newChannelState"
Returns RoomStateTracker

removeListener

removeListener<T>(event: T, fn?: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void, context?: any, once?: boolean): RoomStateTracker

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

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

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Returns RoomStateTracker

Methods

addListener

Type parameters

T: "newChannelState"

Parameters

event: T

fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void

Parameters

Rest ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]

Returns void

Optional context: any

Returns RoomStateTracker

applyToClient

Parameters

client: ChatClient

Returns void

emit

Type parameters

T: "newChannelState"

Parameters

event: T

Rest ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]

Returns boolean

eventNames

Returns "newChannelState"[]

getChannelState

Parameters

channelName: string

Returns undefined | RoomState

listenerCount

Parameters

event: "newChannelState"

Returns number

listeners

Type parameters

T: "newChannelState"

Parameters

event: T

Returns ((...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void)[]

off

Type parameters

T: "newChannelState"

Parameters

event: T

Optional fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void

Parameters

Rest ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]

Returns void

Optional context: any

Optional once: boolean

Returns RoomStateTracker

on

Type parameters

T: "newChannelState"

Parameters

event: T

fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void

Parameters

Rest ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]

Returns void

Optional context: any

Returns RoomStateTracker

once

Type parameters

T: "newChannelState"

Parameters

event: T

fn: (...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]) => void

Parameters

Rest ...args: ArgumentMap<RoomStateTrackerEvents>[Extract<T, "newChannelState">]

Returns void

Optional context: any