Interface RetryPolicy

Structured retry policy configuration for stream messages. Controls retry behavior with exponential backoff.

Example

const retryPolicy: RetryPolicy = {
  maximumAttempts: 5,
  backoffCoefficient: 2,
  maximumInterval: '300s',
};
// Results in delays: 2s, 4s, 8s, 16s, 32s, 64s, 128s, 256s, 300s (capped)
interface RetryPolicy {
    backoffCoefficient?: number;
    maximumAttempts?: number;
    maximumInterval?: string | number;
}

Properties

backoffCoefficient? maximumAttempts? maximumInterval?

Properties

OptionalbackoffCoefficient

backoffCoefficient?: number

Base coefficient for exponential backoff calculation. Retry delay = min(backoffCoefficient ^ attemptNumber, maximumInterval)

Default

10

Example

2

OptionalmaximumAttempts

maximumAttempts?: number

Maximum number of retry attempts before the message fails.

Default

3

Example

5

OptionalmaximumInterval

maximumInterval?: string | number

Maximum interval between retries in seconds or as a duration string. Caps the exponential backoff to prevent excessive delays.

Default

"120s"

Example

"60s" or 60

Settings

Member Visibility

On This Page

Properties