Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Node

Hierarchy

  • EventEmitter
    • Node

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

blockHeight

blockHeight: number | undefined

endpoint

endpoint: string

isActive

isActive: boolean | undefined

isBenchmarking

isBenchmarking: boolean = false

lastPingTimestamp

lastPingTimestamp: number | undefined

lastSeenTimestamp

lastSeenTimestamp: number | undefined

latency

latency: number | undefined

Private logger

logger: Logger

Private options

options: NodeOptions

pendingRequests

pendingRequests: number | undefined

Private requestLogs

requestLogs: any[] = []

Private Optional truncateRequestLogIntervalId

truncateRequestLogIntervalId: NodeJS.Timer

userAgent

userAgent: string | undefined

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

close

  • close(): void

Private decreasePendingRequest

  • decreasePendingRequest(): 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>

getBlock

  • getBlock(height: number, isVerbose?: boolean): Promise<any>

  • Parameters

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

    Returns Promise<any>

getBlockCount

  • getBlockCount(): Promise<any>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getNodeMeta

getNodeReliability

  • getNodeReliability(): number | undefined

  • A float number between 0 an 1

    Returns number | undefined

Private getRequestConfig

  • getRequestConfig(): AxiosRequestConfig

getShapedLatency

  • getShapedLatency(): number | undefined

getTransaction

  • getTransaction(transactionId: string, isVerbose?: boolean): Promise<any>

  • Parameters

    • transactionId: string
    • Default value isVerbose: boolean = true

    Returns Promise<any>

getVersion

  • getVersion(): Promise<any>

Private increasePendingRequest

  • increasePendingRequest(): void

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

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

Private query

  • query(method: string, params?: any[], id?: number): Promise<any>

  • Parameters

    • method: string
    • Default value params: any[] = []
    • Default value id: number = DEFAULT_ID

    Returns Promise<any>

Private queryCompleteHandler

  • queryCompleteHandler(payload: any): void

Private queryInitHandler

  • queryInitHandler(payload: object): void

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 startBenchmark

  • startBenchmark(payload: any): void

Private stopBenchmark

  • stopBenchmark(payload: any): void

Private truncateRequestLog

  • truncateRequestLog(): 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