@mastondzn/dank-twitch-irc / BaseClient

Abstract Class: BaseClient

Defined in: src/client/base-client.ts:15

Extends

• EventEmitter<ClientEvents>

Extended by

• ChatClient
• SingleConnection

Constructors

Constructor

protected new BaseClient(partialConfig?): BaseClient

Defined in: src/client/base-client.ts:42

Parameters

partialConfig?

ClientConfiguration

Returns

BaseClient

Overrides

EventEmitter<ClientEvents>.constructor

Properties

configuration

readonly configuration: ExpandedClientConfiguration

Defined in: src/client/base-client.ts:36

---

joinedChannels

abstract readonly joinedChannels: Set<string>

Defined in: src/client/base-client.ts:38

---

state

state: "UNCONNECTED" | "CONNECTING" | "CONNECTED" | "READY" | "CLOSED" = "UNCONNECTED"

Defined in: src/client/base-client.ts:40

---

wantedChannels

abstract readonly wantedChannels: Set<string>

Defined in: src/client/base-client.ts:37

---

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

Accessors

closed

Get Signature

get closed(): boolean

Defined in: src/client/base-client.ts:32

Returns

boolean

---

connected

Get Signature

get connected(): boolean

Defined in: src/client/base-client.ts:24

Returns

boolean

---

connecting

Get Signature

get connecting(): boolean

Defined in: src/client/base-client.ts:20

Returns

boolean

---

ready

Get Signature

get ready(): boolean

Defined in: src/client/base-client.ts:28

Returns

boolean

---

unconnected

Get Signature

get unconnected(): boolean

Defined in: src/client/base-client.ts:16

Returns

boolean

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 string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.addListener

---

advanceState()

advanceState(newState): boolean

Defined in: src/client/base-client.ts:84

Parameters

newState

"UNCONNECTED" | "CONNECTING" | "CONNECTED" | "READY" | "CLOSED"

Returns

boolean

---

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 string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

Parameters

event

T

args

...ArgumentMap<ClientEvents>[Extract<T, string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents>]

Returns

boolean

Inherited from

EventEmitter.emit

---

emitClosed()

emitClosed(error?): void

Defined in: src/client/base-client.ts:78

Parameters

error?

Error

Returns

void

---

emitConnected()

emitConnected(): void

Defined in: src/client/base-client.ts:66

Returns

void

---

emitConnecting()

emitConnecting(): void

Defined in: src/client/base-client.ts:60

Returns

void

---

emitError()

emitError(error, emitEvenIfClosed?): void

Defined in: src/client/base-client.ts:47

Parameters

error

Error

emitEvenIfClosed?

boolean = false

Returns

void

---

emitMessage()

emitMessage(message): void

Defined in: src/client/base-client.ts:55

Parameters

message

IRCMessage

Returns

void

---

emitReady()

emitReady(): void

Defined in: src/client/base-client.ts:72

Returns

void

---

eventNames()

eventNames(): (string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents)[]

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

(string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents)[]

Inherited from

EventEmitter.eventNames

---

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

string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

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 string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

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 string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

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 string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

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 string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

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?

string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

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 string & Record<never, never> | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.removeListener