zhaoyao91 / retry-times

retry a task many times

Retry Times

Retry a task at most given times.

Deprecation

This package is deprecated to prefer the new retry-func package.

Installation

npm i retry-times --save

Usage

Retry a task directly

const {buildRetry} = require('retry-times')

// a task is any function without argument
const task = async () => {
  ...
}

const retry = buildRetry(3) // or buildRetry({times: 3})
const data = await retry(task)

Wrap a task with retry

const {buildWithRetry} = require('retry-times')

// a task is any function without argument
const task = async () => {
  ...
}

const withRetry = buildWithRetry(3) // or buildWithRetry({times: 3})
const taskWithRetry = withRetry(task)
const data = taskWithRetry()

API

buildRetry

buildRetry(options) => retry(task) => Promise

buildWithRetry

buildWithRetry(options) => withRetry(task) => wrappedTask() => Promise

options

• times - the task will run at most times
• onRetry - onRetry(err, runCount), callback when the task is about to retry

The relations of run, onRetry, and runCount are as below:

run           ->             run           ->             run...
    onRetry(err, runCount=1)     onRetry(err, runCount=2)

License

MIT

retry-times's Issues

[feature request] Add wrapper function withRetry

why not add a high order function shown below, as a built in feature ?

const withRetry = (options, fn) => 
    async (...args) => await retryTimes(async() => await fn(...args), options)

so we can simply code like:

const delay = 100

async function mockFetchFailed(str) {
	console.log(str)
	return new Promise((resolve, reject) => setTimeout(reject('error here'), delay))
}

// Test
(async function test() {
	const fn = withRetry({times:3}, mockFetchFailed)
	const data = await fn('called').catch(console.error)
	console.log(data)
})()