dank-twitch-irc

Appearance

@mastondzn/dank-twitch-irc / UserStateTracker

Class: UserStateTracker ​

Defined in: src/mixins/userstate-tracker.ts:23

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

Extends ​

Implements ​

Constructors ​

Constructor ​

new UserStateTracker(client): UserStateTracker

Defined in: src/mixins/userstate-tracker.ts:31

Parameters ​

client ​

ChatClient

Returns ​

UserStateTracker

Overrides ​

EventEmitter<UserStateTrackerEvents>.constructor

Properties ​

channelStates ​

channelStates: Record<string, UserState> = {}

Defined in: src/mixins/userstate-tracker.ts:28

globalState? ​

optional globalState?: GlobalUserState

Defined in: src/mixins/userstate-tracker.ts:27

prefixed ​

static prefixed: string | boolean

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:9

Inherited from ​

EventEmitter.prefixed

Methods ​

addListener() ​

addListener<T>(event, fn, context?): this

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:45

Type Parameters ​

T ​

T extends keyof UserStateTrackerEvents

Parameters ​

event ​

T

fn ​

(...args) => void

context? ​

any

Returns ​

this

Inherited from ​

EventEmitter.addListener

applyToClient() ​

applyToClient(client): void

Defined in: src/mixins/userstate-tracker.ts:44

Parameters ​

client ​

ChatClient

Returns ​

void

Implementation of ​

ClientMixin.applyToClient

emit() ​

emit<T>(event, ...args): boolean

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters ​

T ​

T extends keyof UserStateTrackerEvents

Parameters ​

event ​

T

args ​

...ArgumentMap<UserStateTrackerEvents>[Extract<T, keyof UserStateTrackerEvents>]

Returns ​

boolean

Inherited from ​

EventEmitter.emit

eventNames() ​

eventNames(): keyof UserStateTrackerEvents[]

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:15

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

Returns ​

keyof UserStateTrackerEvents[]

Inherited from ​

EventEmitter.eventNames

getChannelState() ​

getChannelState(channelName): UserState | undefined

Defined in: src/mixins/userstate-tracker.ts:36

Parameters ​

channelName ​

string

Returns ​

UserState | undefined

getGlobalState() ​

getGlobalState(): GlobalUserState | undefined

Defined in: src/mixins/userstate-tracker.ts:40

Returns ​

GlobalUserState | undefined

listenerCount() ​

listenerCount(event): number

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters ​

event ​

keyof UserStateTrackerEvents

Returns ​

number

Inherited from ​

EventEmitter.listenerCount

listeners() ​

listeners<T>(event): (...args) => void[]

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters ​

T ​

T extends keyof UserStateTrackerEvents

Parameters ​

event ​

T

Returns ​

(...args) => void[]

Inherited from ​

EventEmitter.listeners

off() ​

off<T>(event, fn?, context?, once?): this

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:69

Type Parameters ​

T ​

T extends keyof UserStateTrackerEvents

Parameters ​

event ​

T

fn? ​

(...args) => void

context? ​

any

once? ​

boolean

Returns ​

this

Inherited from ​

EventEmitter.off

on() ​

on<T>(event, fn, context?): this

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters ​

T ​

T extends keyof UserStateTrackerEvents

Parameters ​

event ​

T

fn ​

(...args) => void

context? ​

any

Returns ​

this

Inherited from ​

EventEmitter.on

once() ​

once<T>(event, fn, context?): this

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters ​

T ​

T extends keyof UserStateTrackerEvents

Parameters ​

event ​

T

fn ​

(...args) => void

context? ​

any

Returns ​

this

Inherited from ​

EventEmitter.once

removeAllListeners() ​

removeAllListeners(event?): this

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters ​

event? ​

keyof UserStateTrackerEvents

Returns ​

this

Inherited from ​

EventEmitter.removeAllListeners

removeListener() ​

removeListener<T>(event, fn?, context?, once?): this

Defined in: node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters ​

T ​

T extends keyof UserStateTrackerEvents

Parameters ​

event ​

T

fn? ​

(...args) => void

context? ​

any

once? ​

boolean

Returns ​

this

Inherited from ​

EventEmitter.removeListener