Class PollingManager

Hierarchy

EventEmitter
- PollingManager

Index

Constructors

Accessors

Methods

Constructors

constructor

new PollingManager(
    options: PollingManagerOptions,
    limiter: Limiter,
    logger: LoggerInstance,
    metrics: MetricsDefinitions,
): PollingManager
Create a polling manager
Parameters
- options: PollingManagerOptions
  Polling manager options
- limiter: Limiter
  Rate limiter
- logger: LoggerInstance
  Logger instance
- metrics: MetricsDefinitions
  Metrics registry
Returns PollingManager

Accessors

check

get check(): Check<any>
Return the stats of the polling manager

Returns Check<any>

Methods

on

on(event: "error", listener: (error: Crash | Multi) => void): this
Emitted on every error
Parameters
- event: "error"
- listener: (error: Crash | Multi) => void
Returns this
on(event: "off", listener: (taskId: string, task: TaskBaseConfig) => void): this
Emitted when a task is passed to off, this means that the task has been disabled
Parameters
- event: "off"
- listener: (taskId: string, task: TaskBaseConfig) => void
Returns this
on(
event: "slow",
listener: (taskId: string, task: TaskBaseConfig) => void,
): this
Emitted when a task is passed to slow cycle
Parameters
- event: "slow"
- listener: (taskId: string, task: TaskBaseConfig) => void
Returns this
on(
event: "fast",
listener: (taskId: string, task: TaskBaseConfig) => void,
): this
Emitted when a task is passed to fast cycle
Parameters
- event: "fast"
- listener: (taskId: string, task: TaskBaseConfig) => void
Returns this
on(
    event: "done",
    listener: (
        uuid: string,
        result: any,
        meta: MetaData,
        error?: Crash | Multi,
    ) => void,
): this
Emitted when a task has ended
Parameters
- event: "done"
- listener: (uuid: string, result: any, meta: MetaData, error?: Crash | Multi) => void
Returns this
on(event: "endCycle", listener: (check: Check<PollingStats>) => void): this
Emitted when a cycle has ended
Parameters
- event: "endCycle"
- listener: (check: Check<PollingStats>) => void
Returns this
on(event: "startCycle", listener: () => void): this
Emitted when a cycle has started
Parameters
- event: "startCycle"
- listener: () => void
Returns this

schedule

schedule(): void
Schedule the tasks to be executed

Returns void