Class Connection

Hierarchy (View Summary)

Constructors

constructor

Properties

auth sender socket state stats status url defaultMaxListeners

Methods

addListener close emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener send setMaxListeners listenerCount

Constructors

constructor

Properties

auth

auth: ConnectionAuth

sender

sender: ConnectionSender

socket

socket: Socket

state

state: ConnectionState

stats

stats: ConnectionStats

status

status: ConnectionStatus = Ready

url

url: string

StaticdefaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

close

emit

eventNames

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

  • Returns (string | number)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | number): number

  • Parameters

    • type: string | number

    Returns number

listeners

  • listeners(type: string | number): Listener[]

  • Parameters

    • type: string | number

    Returns Listener[]

off

  • off(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

on

  • on(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

once

  • once(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

prependListener

  • prependListener(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

prependOnceListener

  • prependOnceListener(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

rawListeners

  • rawListeners(type: string | number): Listener[]

  • Parameters

    • type: string | number

    Returns Listener[]

removeAllListeners

  • removeAllListeners(type?: string | number): this

  • Parameters

    • Optionaltype: string | number

    Returns this

removeListener

  • removeListener(type: string | number, listener: Listener): this

  • Parameters

    • type: string | number
    • listener: Listener

    Returns this

send

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

StaticlistenerCount

  • listenerCount(emitter: EventEmitter, type: string | number): number

  • Parameters

    • emitter: EventEmitter
    • type: string | number

    Returns number

Settings

Member Visibility

On This Page

Constructors
Properties
Methods