Class PeriodicRetry

A simple periodic retry mechanism

Hierarchy (view full)

Constructors

constructor

Properties

jobs config

Methods

run calculateNextWait

Constructors

constructor

Properties

Protected jobs

jobs: {
    [id: string]: InternalJobData;
} = {}

A map of job ids to data about the job

Type declaration

Protected config

config: {
    initialWaitMs: number;
    intervalMs: number;
    maxRetryMs: number;
}

Type declaration

  • initialWaitMs: number

    The initial delay

  • intervalMs: number

    The delay for all retries after the first one

  • maxRetryMs: number

    The max number of ms to retry before giving up and throwing a RetryTimeoutError. Note that this is an absolute value which includes time spent actually running the job. For example, if you set this to 1 hour and your job takes 30 minutes to run, you will only get 2 retries.

Methods

run

  • run(job, log, _jobId?): Promise<boolean>

  • Run a job, retrying on failure according to the logic of the concrete class used.

    Parameters

    • job: (() => Promise<boolean>)
        • (): Promise<boolean>

        • Returns Promise<boolean>

    • log: SimpleLoggerInterface
    • Optional _jobId: string

    Returns Promise<boolean>

Protected calculateNextWait

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc