@byungi/p-retry

Retry when promise fails.

Example

1const runner = async () => {
2    await asyncJobOrFail()
3}
4
5try{
6    await pRetry(runner, {retries: 3})
7}catch(err){
8    console.log('3 retries, but all failed.')
9}

API

pRetry(runner[, options])

Retry when promise fails.

runner

A function that retries when a promise is rejected. This function should return promise.

options

• retries - Number of retries. Default is 1.
• interval - Delay before retry. Default is 0.

promise.cancel([reason])

Do not retry anymore and throw a CancelError.

1import pRetry, {CancelError} from '@byungi/p-retry'
2
3const retryPromise = pRetry(asyncAlwaysFailRequest, {retries: 1000})
4
5setTimeout(()=> retryPromise.cancel(), 100) // After 100ms, retry is aborted.
6
7retryPromise.catch(err => {
8    console.log(err.isCanceled) // => true
9    console.log(err instanceof CancelError) // => true
10    console.log(retryPromise.isCanceled) // => true
11})

promise.isCanceled

Returns whether the promise is canceled.

promise.pipe(onFulfilled, onRejected)

Similar to then but can propagate cancel to the upper promise.

1const handleWithRequestPromise = retryPromise.pipe(response => {
2    handleResponse(response)
3})
4
5handleWithRequestPromise.cancel() // => retry is aborted.

License

MIT