Class Retry<T>

Retry a task

Type Parameters

T extends any

Hierarchy

Retry

Index

Constructors

Accessors

isRunning options

Methods

Constructors

constructor

new Retry<T>(task: RetryTask<T>, options?: RetryOptions): Retry<T>
Throws
!TypeError If the parameters are invalid
Type Parameters
- T extends unknown
Parameters
- task: RetryTask<T>
  
  The task to retry
- Optional options: RetryOptions
  
  The options to use
Returns Retry<T>
- Defined in packages/retry/src/retry.ts:106

Accessors

isRunning

get isRunning(): boolean
Determine whether the task is running or not

Returns boolean
- Defined in packages/retry/src/retry.ts:144

options

get options(): Required<RetryOptions>
The options of the retry operation

Returns Required<RetryOptions>
- Defined in packages/retry/src/retry.ts:137

Methods

abort

abort(): void
Abort the task

Remarks
If the task is not running, this method does nothing. If the task is running, it will be aborted and the promise returned by () will be rejected with an AbortError.

Returns void
- Defined in packages/retry/src/retry.ts:176

run

run(): Promise<Awaited<T>>
Run the task

Returns
The result of the task

Throws
AbortError

Throws
Error If the task fails and the retry limit is reached

Returns Promise<Awaited<T>>
- Defined in packages/retry/src/retry.ts:155

then

then<TResult1, TResult2>(onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): Promise<TResult1 | TResult2>
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
- Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
Returns Promise<TResult1 | TResult2>
- Defined in packages/retry/src/retry.ts:159

Generated using TypeDoc