RetryDelay class sealed

How long to wait before the next attempt after a failure — the retryDelay option. Only consulted when RetryPolicy decided to retry.

Default: RetryDelay.defaultValue: one second, then two, four, …, never more than thirty seconds (the same numbers as TanStack Query).

retryDelay: RetryDelay.defaultValue            // 1s, 2s, 4s, … max 30s
retryDelay: const RetryDelay.fixed(Duration(seconds: 2))
retryDelay: const RetryDelay.exponential(
  base: Duration(milliseconds: 200),
  maximum: Duration(seconds: 5),
)
retryDelay: RetryDelay.dynamic(
  (failureCount, error) => error is RateLimited
      ? error.retryAfter
      : const Duration(seconds: 1),
)

Annotations

• @immutable

Constructors

RetryDelay.dynamic(Duration compute(int failureCount, Object error))

Computed per failure (TanStack Query: retryDelay: (attempt, error) => ms). failureCount is how many attempts had failed before the one that just did, so it is 0 before the first retry. Named like StaleTime.dynamic and RefetchInterval.dynamic, the other values computed on demand.

const

factory

RetryDelay.exponential({Duration base, Duration maximum})

Doubles from base on every failure and never exceeds maximum. With no arguments this is defaultValue: one second, two, four, … capped at thirty.

const

factory

RetryDelay.fixed(Duration delay)

The same wait before every retry (TanStack Query: retryDelay: ms).

const

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resolve(int failureCount, Object error) → Duration

The wait before the next attempt, after an attempt threw error with failureCount failures before it.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

defaultValue → const RetryDelay

The default: min(1s * 2^failureCount, 30s) — one second, two, four, … capped at thirty.