Obs Client
Functions
Functions
shouldRetry
Check if an error should be retried based on attempt count and error type
Signature:
shouldRetry(error: unknown, attempt: number, maxRetries: number, isRetriableError: (error: unknown) => boolean): boolean
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
error | unknown | Yes | |
attempt | number | Yes | |
maxRetries | number | Yes | |
isRetriableError | (error: unknown) => boolean | Yes |
Returns:
boolean -
calculateExponentialBackoff
Calculate exponential backoff delay with max cap
Signature:
calculateExponentialBackoff(attempt: number, maxDelay?: number): number
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
attempt | number | Yes | - Current retry attempt (0-based) |
maxDelay | number | No | - Maximum delay in milliseconds (default: 10000) |
Returns:
number - Delay in milliseconds
delay
Wait for specified milliseconds
Signature:
delay(ms: number): Promise<void>
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
ms | number | Yes |
Returns:
Promise<void> -
withRetry
Execute a function with retry logic
Signature:
withRetry(fn: () => Promise<T>, options: RetryOptions, config: RetryConfig): Promise<T>
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fn | () => Promise<T> | Yes | |
options | RetryOptions | Yes | |
config | RetryConfig | Yes |
Returns:
Promise<T> -