Metadata

Metadata<E> = object

Defined in: Types/RetryPolicy.ts:42

Observational telemetry metadata provided to onRetry callbacks immediately before each retry delay.

Provides context on the current attempt count, the error that triggered the retry, and the calculated backoff delay before the next attempt executes.

See

RetryPolicy for configuring retry attempts and backoff strategies.

Example

const onRetry = (metadata: RetryPolicy.Metadata<Error>) => {
  console.warn(
    `Attempt ${metadata.attempt} failed: ${metadata.error.message}. Retrying in ${Duration.to.milliseconds(metadata.delay)}ms.`
  );
};

Type Parameters

E

E = unknown

Properties

attempt

readonly attempt: number

Defined in: Types/RetryPolicy.ts:42

---

delay

readonly delay: Duration

Defined in: Types/RetryPolicy.ts:42

---

error

readonly error: E

Defined in: Types/RetryPolicy.ts:42