agentskit.js

RetryOptions

Auto-generated API reference for RetryOptions.

Interface: RetryOptions

Defined in: utils.ts:351

Retry knobs for adapter fetches. Tunable per call to createStreamSource.

Default behavior:

  • 3 attempts total (1 initial + 2 retries)
  • exponential backoff: 500ms, 1000ms, 2000ms ... (capped at maxDelayMs)
  • full jitter on each delay
  • retry on HTTP 408, 429, 500, 502, 503, 504
  • retry on network errors (fetch throws)
  • DO NOT retry on 4xx other than 408/429 (those are bad requests / auth)
  • retries only the initial fetch — never mid-stream
  • respects Retry-After header when present

#Properties

#baseDelayMs?

optional baseDelayMs?: number

Defined in: utils.ts:353


#jitter?

optional jitter?: boolean

Defined in: utils.ts:355


#maxAttempts?

optional maxAttempts?: number

Defined in: utils.ts:352


#maxDelayMs?

optional maxDelayMs?: number

Defined in: utils.ts:354


#onRetry?

optional onRetry?: (info) => void

Defined in: utils.ts:358

Hook for tests + logging. Called after every failed attempt.

#Parameters

info
attempt

number

delayMs

number

reason

string

#Returns

void


#retryOn?

optional retryOn?: (info) => boolean

Defined in: utils.ts:356

#Parameters

info
attempt

number

error?

unknown

response?

Response

#Returns

boolean


#sleep?

optional sleep?: (ms) => Promise<void>

Defined in: utils.ts:360

Sleep override for tests. Defaults to setTimeout.

#Parameters

ms

number

#Returns

Promise<void>

Explore nearby

✎ Edit this page on GitHub·Found a problem? Open an issue →·How to contribute →

On this page