Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChatClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly configuration

configuration: ExpandedClientConfiguration

Readonly connectionMixins

connectionMixins: ConnectionMixin[] = []

Optional connectionPool

connectionPool?: ConnectionPool

Readonly connections

connections: SingleConnection[] = []

Optional roomStateTracker

roomStateTracker?: RoomStateTracker

state

state: ClientState = ClientState.UNCONNECTED

Optional userStateTracker

userStateTracker?: UserStateTracker

Accessors

closed

  • get closed(): boolean

connected

  • get connected(): boolean

connecting

  • get connecting(): boolean

joinedChannels

  • get joinedChannels(): Set<string>

ready

  • get ready(): boolean

unconnected

  • get unconnected(): boolean

wantedChannels

  • get wantedChannels(): Set<string>

Methods

addListener

  • addListener<T>(event: T, fn: (...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>]) => void, context?: any): ChatClient

  • Type parameters

    • T: (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: 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>]) => void
        • (...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>]): void

        • Parameters

          • Rest ...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 void

    • Optional context: any

    Returns ChatClient

advanceState

close

  • close(): void

connect

  • connect(): Promise<void>

destroy

  • destroy(error?: Error): void

emit

  • emit<T>(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>]): boolean

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

    Type parameters

    • T: (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
    • Rest ...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

emitClosed

  • emitClosed(error?: Error): void

emitConnected

  • emitConnected(): void

emitConnecting

  • emitConnecting(): void

emitError

  • emitError(error: Error, emitEvenIfClosed?: boolean): void

emitMessage

emitReady

  • emitReady(): 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)[]

  • 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)[]

join

  • join(channelName: string): Promise<void>

joinAll

  • joinAll(channelNames: string[]): Promise<Record<string, undefined | Error>>

listenerCount

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

  • 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

listeners

  • listeners<T>(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>]) => void)[]

  • Return the listeners registered for a given event.

    Type parameters

    • T: (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: 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>]) => void)[]

me

  • me(channelName: string, message: string): Promise<void>

newConnection

off

  • off<T>(event: T, fn?: (...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>]) => void, context?: any, once?: boolean): ChatClient

  • Type parameters

    • T: (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
    • Optional fn: (...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>]) => void
        • (...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>]): void

        • Parameters

          • Rest ...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 void

    • Optional context: any
    • Optional once: boolean

    Returns ChatClient

on

  • on<T>(event: T, fn: (...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>]) => void, context?: any): ChatClient

  • Add a listener for a given event.

    Type parameters

    • T: (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: 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>]) => void
        • (...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>]): void

        • Parameters

          • Rest ...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 void

    • Optional context: any

    Returns ChatClient

once

  • once<T>(event: T, fn: (...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>]) => void, context?: any): ChatClient

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

    Type parameters

    • T: (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: 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>]) => void
        • (...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>]): void

        • Parameters

          • Rest ...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 void

    • Optional context: any

    Returns ChatClient

part

  • part(channelName: string): Promise<void>

ping

  • ping(): Promise<void>

privmsg

  • privmsg(channelName: string, message: string): Promise<void>

removeAllListeners

  • removeAllListeners(event?: (string & Record<never, never>) | "CLEARCHAT" | "CLEARMSG" | "GLOBALUSERSTATE" | "HOSTTARGET" | "NOTICE" | "PRIVMSG" | "ROOMSTATE" | "USERNOTICE" | "USERSTATE" | "WHISPER" | "JOIN" | "PART" | "RECONNECT" | "PING" | "PONG" | "CAP" | keyof SpecificClientEvents): ChatClient

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

    Parameters

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

    Returns ChatClient

removeListener

  • removeListener<T>(event: T, fn?: (...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>]) => void, context?: any, once?: boolean): ChatClient

  • Remove the listeners of a given event.

    Type parameters

    • T: (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
    • Optional fn: (...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>]) => void
        • (...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>]): void

        • Parameters

          • Rest ...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 void

    • Optional context: any
    • Optional once: boolean

    Returns ChatClient

reply

  • reply(channelName: string, messageID: string, message: string): Promise<void>

  • Parameters

    • channelName: string
    • messageID: string

      The message ID you want to reply to.

    • message: string

    Returns Promise<void>

requireConnection

  • Finds a connection from the list of connections that satisfies the given predicate, or if none was found, returns makes a new connection. This means that the given predicate must be specified in a way that a new connection always satisfies it.

    Parameters

    Returns SingleConnection

say

  • say(channelName: string, message: string): Promise<void>

sendRaw

  • sendRaw(command: string): void

  • Sends a raw IRC command to the server, e.g. JOIN #forsen.

    Throws an exception if the passed command contains one or more newline characters.

    Parameters

    • command: string

      Raw IRC command.

    Returns void

use

Generated using TypeDoc