Class Client

Hierarchy

  • EventEmitter
    • Client

Constructors

constructor

Properties

config host prefixed

Methods

addListener connect emit eventNames listen listenerCount listeners off on once removeAllListeners removeListener send

Constructors

constructor

Properties

config

config: ClientOptions

host

host: Host

Staticprefixed

prefixed: string | boolean

Methods

addListener

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

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

connect

emit

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

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

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Rest...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

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

    Returns (string | symbol)[]

listen

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args: any[]) => void)[]

off

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

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optionalfn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

on

  • on(event, listener): this

  • Add a listener for a given event.

    Parameters

    • event: "connect"
    • listener: ((netID: number) => void)
        • (netID): void

        • Parameters

          • netID: number

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "raw"
    • listener: ((netID: number, channelID: number, data: Buffer) => void)
        • (netID, channelID, data): void

        • Parameters

          • netID: number
          • channelID: number
          • data: Buffer

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "ready"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((error: Error, data?: Buffer) => void)
        • (error, data?): void

        • Parameters

          • error: Error
          • Optionaldata: Buffer

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "disconnect"
    • listener: ((netID: number) => void)
        • (netID): void

        • Parameters

          • netID: number

          Returns void

    Returns this

once

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

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

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

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

    Parameters

    • Optionalevent: string | symbol

    Returns this

removeListener

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

  • Remove the listeners of a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optionalfn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

send

Settings

Member Visibility

On This Page

Constructors
Properties
Methods