Class EventPoller

The EventPoller class provides a convenient way to poll events from the Massa network.

Hierarchy

  • EventEmitter
    • EventPoller

Constructors

constructor

Properties

eventsFilter intervalId lastSlot pollIntervalMs provider prefixed

Methods

addListener emit eventNames listenerCount listeners off on once poll removeAllListeners removeListener start stop start

Constructors

constructor

  • new EventPoller(provider, eventsFilter, pollIntervalMs): EventPoller

  • Constructor of the EventPoller object.

    Parameters

    • provider: Provider

      The provider to use for polling.

    • eventsFilter: EventFilter

      The filter to use for the events.

    • pollIntervalMs: number

      The interval in milliseconds to poll for events.

    Returns EventPoller

Properties

Private Readonly eventsFilter

eventsFilter: EventFilter

The filter to use for the events.

Private intervalId

intervalId: Timeout

Private lastSlot

lastSlot: Slot

Private Readonly pollIntervalMs

pollIntervalMs: number

The interval in milliseconds to poll for events.

Private Readonly provider

provider: Provider

The provider to use for polling.

Static prefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Rest ...args: any[]

    Returns boolean

eventNames

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

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event): ((...args) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args) => void)[]

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

    Returns this

Private poll

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

Private start

Private stop

Static start

  • start(provider, eventsFilter, onData?, onError?, pollIntervalMs?): {
        stopPolling: (() => void);
    }

  • Starts polling for events and returns the stopPolling function.

    Parameters

    • provider: Provider

      The provider to use for polling.

    • eventsFilter: EventFilter

      The filter to use for the events.

    • Optional onData: ((data) => void)

      The callback function to call when new events are found.

        • (data): void

        • Parameters

          Returns void

    • Optional onError: ((err) => void)

      The callback function to call when an error occurs.

        • (err): void

        • Parameters

          • err: Error

          Returns void

    • pollIntervalMs: number = DEFAULT_POLL_INTERVAL_MS

      The interval in milliseconds to poll for events. Default is 1000Ms.

    Returns {
        stopPolling: (() => void);
    }

    An object containing the stopPolling function.

    • stopPolling: (() => void)
        • (): void

        • Returns void

Settings

Member Visibility

Theme

On This Page

constructoreventsFilterintervalIdlastSlotpollIntervalMsproviderprefixedaddListeneremiteventNameslistenerCountlistenersoffononcepollremoveAllListenersremoveListenerstartstopstart