Wondering what’s next for npm?Check out our public roadmap! »

mulligan

1.0.3 • Public • Published

Mulligan

npm Travis Code Climate Code Climate Coverage

A simple JavaScript helper for adding a retry interval for rejected promises.

Installation

$ npm install mulligan --save

Usage

Mulligan works with any promise library that implements an ES6 style promise constructor. It works by wrapping a resolver function.

var Promise = require('any-supported-promise-library')
var mulligan = require('mulligan')
 
var promise = new Promise(mulligan(
  5, // the number of times to try before rejecting
  1000, // the number of milliseconds to wait between retries
  function (resolve, reject) {} // promise resolver
))

Conditional Retries

Mulligan takes a function as an optional fourth argument to support conditional retries. It receives the error from the last rejection as the first argument. If the function returns true it will move on the the next attempt. If the function returns false the promise will be rejected immediately.

Install

npm i mulligan

DownloadsWeekly Downloads

1

Version

1.0.3

License

MIT

Last publish

Collaborators

  • avatar