retryify v6.0.0

retryify

Quickly and easily wrap functions to make them retry when they fail.

Installation

$ npm install retryify

Example

// create a new retryify wrapper with some options set.
const retryify = require('retryify')({
  retries: 5,
  timeout: 1000,
  factor: 2,
  errors: [RequestError, StatusCodeError],
  log: function(msg) { console.log(msg); },
});

// promisified request library
const request = require('request-promise');

// get will now retry each time it catches a RequestError or a
// StatusCodeError, it retries 5 times, or the request finally resolves
// successfully.
const get = retryify(function(url) {
  return request(url);
});

// or, add some custom options for this specific function
const post = retryify({
  retries: 10
}, function(url, data) {
  return request({
    uri: url,
    method: 'POST',
  });
});

// send the request, but retry if it fails.
get('http://google.com')
  .then(...)
  .catch(...);

retryify(options) ⇒ function

Retry module setup function. Takes an options object that configures the default retry options.

Kind: global function Returns: function - retryWrapper A decorator function that wraps a a function to turn it into a retry-enabled function. Throws:

• TypeError when function is passed instead of options object. To use retryify it first must be "constructed" by passing in an options object and the returned function is what is supposed to take the function to retry.

retryify~retryWrapper(innerOptions, fn) ⇒ function

retryify function decorator. Allows configuration on a function by function basis.

Kind: inner method of retryify Returns: function - The wrapped function.

Options : Object

Kind: global typedef Properties