Class RetryInterceptor

Automatic retry for idempotent methods.

Implements

Interceptor

Index

Constructors

Methods

onError shouldRetry backoffSeconds

Constructors

constructor

new RetryInterceptor(policy?: Partial<RetryPolicy>): RetryInterceptor
Parameters
- Optionalpolicy: Partial<RetryPolicy>
Returns RetryInterceptor

Methods

onError

onError(ctx: CallContext, error: RpcError): Promise<RpcError>
Parameters
- ctx: CallContext
- error: RpcError
Returns Promise<RpcError>
Implementation of Interceptor.onError

shouldRetry

shouldRetry(error: RpcError, attempt: number, idempotent?: boolean): boolean
Decide if a call should be retried. Returns true if the error is retryable, call is idempotent, and attempts remain.
Parameters
- error: RpcError
- attempt: number
- idempotent: boolean = false
Returns boolean

backoffSeconds

backoffSeconds(attempt: number): number
Compute backoff duration in seconds for the given attempt number.
Parameters
- attempt: number
Returns number