RetryPolicy

RetryPolicy: object

Defined in: Types/RetryPolicy.ts:34

Type Declaration

constant

constant: <E>(options) => RetryPolicy<E>

Creates a RetryPolicy with a constant delay between retry attempts.

Type Parameters

E

E = unknown

Parameters

options

attempts

number

delay

Duration

onRetry?

(event) => void

when?

(error) => boolean

Returns

RetryPolicy<E>

Example

const policy = RetryPolicy.constant({
  attempts: 3,
  delay: Duration.seconds(1),
});

exponential

exponential: <E>(options) => RetryPolicy<E>

Creates a RetryPolicy with exponential backoff delays between attempts. An optional factor (default 2) controls the growth rate. An optional jitter (default false) adds randomized variance to prevent thundering herd problems. An optional maxDelay caps the maximum duration between retry attempts. An optional when predicate filters which errors qualify for retry. An optional onRetry callback executes telemetry side-effects before each retry delay.

Type Parameters

E

E = unknown

Parameters

options

attempts

number

factor?

number

initial

Duration

jitter?

boolean

maxDelay?

Duration

onRetry?

(event) => void

when?

(error) => boolean

Returns

RetryPolicy<E>

Example

const policy = RetryPolicy.exponential({
  attempts: 5,
  initial: Duration.milliseconds(100),
  factor: 2,
  jitter: true,
  maxDelay: Duration.seconds(5),
  when: (err: Error) => err.name === "NetworkError",
  onRetry: (event) => console.warn(`Retry attempt ${event.attempt}`),
});