Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pinger

Hierarchy

  • EventEmitter
    • Pinger

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Pinger(portOrOptions?: number | IPingerOptions, host?: string, socketOptions?: SocketConstructorOpts): Pinger

Properties

connected

connected: boolean = false

options

options: IPingerOptions

retries

retries: number = 0

socket

socket: Socket

Private timeoutId

timeoutId: Timeout

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

host

  • get host(): string

port

  • get port(): number

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): Pinger

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Pinger

destroy

  • destroy(): void

disable

  • disable(): void

Private dispatch

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

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

    Returns boolean

enable

  • enable(): void

eventNames

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

  • Returns (string | symbol)[]

Private finished

  • finished(): void

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

on

once

  • once(event: string | symbol, listener: (...args: any[]) => void): Pinger

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Pinger

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): Pinger

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Pinger

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Pinger

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Pinger

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

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

  • Parameters

    • Optional event: string | symbol

    Returns Pinger

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): Pinger

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Pinger

Private reset

  • reset(): void

Private retry

  • retry(): void

setMaxListeners

  • setMaxListeners(n: number): Pinger

  • Parameters

    • n: number

    Returns Pinger

start

  • start(onConnected?: (retries?: number, pinger?: Pinger) => void): Pinger

  • Parameters

    • Optional onConnected: (retries?: number, pinger?: Pinger) => void
        • (retries?: number, pinger?: Pinger): void

        • Parameters

          • Optional retries: number
          • Optional pinger: Pinger

          Returns void

    Returns Pinger

stop

  • stop(): void

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc