Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

exitedAfterDisconnect

exitedAfterDisconnect: boolean

id

id: number

process

process: ChildProcess

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string, listener: function): this
  • addListener(event: "disconnect", listener: function): this
  • addListener(event: "error", listener: function): this
  • addListener(event: "exit", listener: function): this
  • addListener(event: "listening", listener: function): this
  • addListener(event: "message", listener: function): this
  • addListener(event: "online", listener: function): this
  • events.EventEmitter

    1. disconnect
    2. error
    3. exit
    4. listening
    5. message
    6. online

    Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number, signal: string): void
        • Parameters

          • code: number
          • signal: string

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function

    Returns this

  • Parameters

    • event: "message"
    • listener: function

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void
        • Returns void

    Returns this

destroy

  • destroy(signal?: undefined | string): void
  • Parameters

    • Optional signal: undefined | string

    Returns void

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "disconnect"): boolean
  • emit(event: "error", error: Error): boolean
  • emit(event: "exit", code: number, signal: string): boolean
  • emit(event: "listening", address: Address): boolean
  • emit(event: "message", message: any, handle: Socket | Server): boolean
  • emit(event: "online"): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "disconnect"

    Returns boolean

  • Parameters

    • event: "error"
    • error: Error

    Returns boolean

  • Parameters

    • event: "exit"
    • code: number
    • signal: string

    Returns boolean

  • Parameters

    • event: "listening"
    • address: Address

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "online"

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

isConnected

  • isConnected(): boolean
  • Returns boolean

isDead

  • isDead(): boolean
  • Returns boolean

kill

  • kill(signal?: undefined | string): void
  • Parameters

    • Optional signal: undefined | string

    Returns void

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string, listener: function): this
  • on(event: "disconnect", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: "exit", listener: function): this
  • on(event: "listening", listener: function): this
  • on(event: "message", listener: function): this
  • on(event: "online", listener: function): this
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number, signal: string): void
        • Parameters

          • code: number
          • signal: string

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function

    Returns this

  • Parameters

    • event: "message"
    • listener: function

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void
        • Returns void

    Returns this

once

  • once(event: string, listener: function): this
  • once(event: "disconnect", listener: function): this
  • once(event: "error", listener: function): this
  • once(event: "exit", listener: function): this
  • once(event: "listening", listener: function): this
  • once(event: "message", listener: function): this
  • once(event: "online", listener: function): this
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number, signal: string): void
        • Parameters

          • code: number
          • signal: string

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function

    Returns this

  • Parameters

    • event: "message"
    • listener: function

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void
        • Returns void

    Returns this

prependListener

  • prependListener(event: string, listener: function): this
  • prependListener(event: "disconnect", listener: function): this
  • prependListener(event: "error", listener: function): this
  • prependListener(event: "exit", listener: function): this
  • prependListener(event: "listening", listener: function): this
  • prependListener(event: "message", listener: function): this
  • prependListener(event: "online", listener: function): this
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number, signal: string): void
        • Parameters

          • code: number
          • signal: string

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function

    Returns this

  • Parameters

    • event: "message"
    • listener: function

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void
        • Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: function): this
  • prependOnceListener(event: "disconnect", listener: function): this
  • prependOnceListener(event: "error", listener: function): this
  • prependOnceListener(event: "exit", listener: function): this
  • prependOnceListener(event: "listening", listener: function): this
  • prependOnceListener(event: "message", listener: function): this
  • prependOnceListener(event: "online", listener: function): this
  • Parameters

    • event: string
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • event: "disconnect"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns this

  • Parameters

    • event: "exit"
    • listener: function
        • (code: number, signal: string): void
        • Parameters

          • code: number
          • signal: string

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function

    Returns this

  • Parameters

    • event: "message"
    • listener: function

    Returns this

  • Parameters

    • event: "online"
    • listener: function
        • (): void
        • Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

send

  • send(message: any, sendHandle?: any, callback?: undefined | function): boolean
  • Parameters

    • message: any
    • Optional sendHandle: any
    • Optional callback: undefined | function

    Returns boolean

setMaxListeners

  • setMaxListeners(n: number): this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc