Skip to main content
Version: API v2 Preview

RetryConfig

Kind: interface
Module/package: pdfdancer_v2
SDK: pdfdancer-client-typescript 2.0.0

Configuration for retry mechanism on REST API calls.

Declaration

interface RetryConfig

Members

backoffMultiplier

backoffMultiplier?: number

Exponential backoff multiplier (default: 2)

initialDelay

initialDelay?: number

Initial delay in milliseconds before first retry (default: 1000) Subsequent delays use exponential backoff

maxAttempts

maxAttempts?: number

Total number of attempts, including the initial request (default: 3)

maxDelay

maxDelay?: number

Maximum delay in milliseconds between retries (default: 5000)

respectRetryAfter

respectRetryAfter?: boolean

Whether to respect Retry-After headers from server responses (default: true) When enabled, the client will use the server-specified delay instead of exponential backoff for responses that include a Retry-After header (typically 429 or 503 responses)

retryableStatusCodes

retryableStatusCodes?: number[]

HTTP status codes that should trigger a retry (default: [429, 500, 502, 503, 504])

retryOnNetworkError

retryOnNetworkError?: boolean

Whether to retry on network errors (connection failures, timeouts) (default: true)

View source at 7bd49ac104cc