Skip to content

A simple promise retry implementation that will retry a promise X times before rejecting.

Notifications You must be signed in to change notification settings

poetic/retryable-promise

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

retryable-promise Build Status

A simple promise retry implementation that will retry a promise X times before rejecting.

Works with any compliant promise library in Node or the browser;

Installation

  • npm install --save retryable-promise

Usage

You pass in a function that returns a promise as the first argument and it will retry it up to 3 times until failing. It returns a promise that you can chain from like normal.

You can also optionally pass in an options object as the second argument. It accepts a maxRetry key to alter how many times it will retry the promise before failing. By default, a retry will be attempted immediately however, you can use the timeout key with a value of milliseconds to wait before retrying.

For example, to retry a promise up to 5 times and wait 1 second between each attempt:

return retryablePromise(yourPromise(), {
  maxRetries: 5,
  timeout: 1000
});

Running Tests

  • npm test

About

A simple promise retry implementation that will retry a promise X times before rejecting.

Resources

Stars

Watchers

Forks

Packages