Interface IAsyncRetryOptions

Hierarchy

  • WrapOptions
    • IAsyncRetryOptions

Properties

factor? forever? maxRetryTime? maxTimeout? minTimeout? onRetry? randomize? retries? unref?

Properties

Optional factor

factor?: number

The exponential factor to use.

Default

2

Optional forever

forever?: boolean

Whether to retry forever.

Default

false

Optional maxRetryTime

maxRetryTime?: number

The maximum time (in milliseconds) that the retried operation is allowed to run.

Default

Infinity

Optional maxTimeout

maxTimeout?: number

The maximum number of milliseconds between two retries.

Default

Infinity

Optional minTimeout

minTimeout?: number

The number of milliseconds before starting the first retry.

Default

1000

Optional onRetry

onRetry?: ((e, attempt) => any)

Type declaration

    • (e, attempt): any

    • An optional function that is invoked after a new retry is performed. It's passed the Error that triggered it as a parameter.

      Parameters

      • e: Error
      • attempt: number

      Returns any

Optional randomize

randomize?: boolean

Randomizes the timeouts by multiplying a factor between 1-2.

Default

false

Optional retries

retries?: number

The maximum amount of times to retry the operation.

Default

10

Optional unref

unref?: boolean

Whether to unref the setTimeout's.

Default

false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc