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:

ParameterTypeRequiredDescription
errorunknownYes
attemptnumberYes
maxRetriesnumberYes
isRetriableError(error: unknown) => booleanYes

Returns:

boolean -

calculateExponentialBackoff

Calculate exponential backoff delay with max cap

Signature:

calculateExponentialBackoff(attempt: number, maxDelay?: number): number

Parameters:

ParameterTypeRequiredDescription
attemptnumberYes- Current retry attempt (0-based)
maxDelaynumberNo- Maximum delay in milliseconds (default: 10000)

Returns:

number - Delay in milliseconds

delay

Wait for specified milliseconds

Signature:

delay(ms: number): Promise<void>

Parameters:

ParameterTypeRequiredDescription
msnumberYes

Returns:

Promise<void> -

withRetry

Execute a function with retry logic

Signature:

withRetry(fn: () => Promise<T>, options: RetryOptions, config: RetryConfig): Promise<T>

Parameters:

ParameterTypeRequiredDescription
fn() => Promise<T>Yes
optionsRetryOptionsYes
configRetryConfigYes

Returns:

Promise<T> -

Previous
Classes