Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Mesh

Hierarchy

  • EventEmitter
    • Mesh

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _isReady

_isReady: boolean = false

Private Optional benchmarkIntervalId

benchmarkIntervalId: NodeJS.Timer

Private Optional fetchMissingUserAgentIntervalId

fetchMissingUserAgentIntervalId: NodeJS.Timer

Private logger

logger: Logger

nodes

nodes: Node[]

Private options

options: MeshOptions

Private Optional refreshUserAgentIntervalId

refreshUserAgentIntervalId: NodeJS.Timer

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private checkMeshReady

  • checkMeshReady(): void

close

  • close(): void

emit

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

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getFastestNode

  • getFastestNode(activeOnly?: boolean): Node | undefined

  • Parameters

    • Default value activeOnly: boolean = true

    Returns Node | undefined

getHighestNode

  • getHighestNode(activeOnly?: boolean): Node | undefined

  • Parameters

    • Default value activeOnly: boolean = true

    Returns Node | undefined

getMaxListeners

  • getMaxListeners(): number

  • Returns number

Private getNodeToBenchmark

  • getNodeToBenchmark(): Node | undefined

getOptimalNode

  • getOptimalNode(height: number, activeOnly?: boolean): Node | undefined

  • An optimal node is defined as a fast node that has not exceed a pending threshold.

    Parameters

    • height: number
    • Default value activeOnly: boolean = true

    Returns Node | undefined

getRandomNode

  • getRandomNode(activeOnly?: boolean): Node | undefined

  • Parameters

    • Default value activeOnly: boolean = true

      Toggle to only pick node that is determined to be active.

    Returns Node | undefined

isReady

  • isReady(): boolean

Private listActiveNodes

  • listActiveNodes(): Node[]

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

  • 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 | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private performBenchmark

  • performBenchmark(): void

Private performFetchMissingUserAgent

  • performFetchMissingUserAgent(): void

Private performRefreshUserAgent

  • performRefreshUserAgent(): void

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

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

  • Parameters

    • Optional event: string | symbol

    Returns 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

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Private setReady

  • setReady(): void

startBenchmark

  • startBenchmark(): void

stopBenchmark

  • stopBenchmark(): void

Private validateOptionalParameters

  • validateOptionalParameters(): void

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc