RetryPolicy

RetryPolicy<E> = object

Defined in: Types/RetryPolicy.ts:19

An immutable policy describing retry limits, backoff delay strategies, transient failure filters, and observational telemetry.

Example

const policy: RetryPolicy<Error> = RetryPolicy.exponential({
  attempts: 3,
  initial: Duration.milliseconds(100),
  when: (err) => err.name === "NetworkError",
  onRetry: (metadata) => console.warn(`Retrying attempt ${metadata.attempt}: ${metadata.error.message}`),
});

Type Parameters

E

E = unknown

Properties

attempts

readonly attempts: number

Defined in: Types/RetryPolicy.ts:24

Total number of attempts, including the first. A positive integer; 1 means no retry. Any other value is treated as one attempt.

---

getDelay

readonly getDelay: (attempt) => Duration

Defined in: Types/RetryPolicy.ts:25

Parameters

attempt

number

Returns

Duration

---

onRetry?

readonly optional onRetry?: (metadata) => void

Defined in: Types/RetryPolicy.ts:27

Parameters

metadata

Metadata<E>

Returns

void

---

when?

readonly optional when?: (error) => boolean

Defined in: Types/RetryPolicy.ts:26

Parameters

error

E

Returns

boolean