promise-retryable v1.1.0

promise-retryable

Retries a function which returns a promise, with configurable backoff and attempts.

Installation

npm install promise-retryable

yarn add promise-retryable

Usage

The final resolved value would be an object containing the value and attempt in which it got resolved.

retry(fn).then({ value, attempt })

• With default settings

  import axios from 'axios'
  import retry from 'promise-retyable'
  
  const fn = () => axios('http://someurl')
  retry(fn).then(
    ({ value, attempt }) => {
      // fulfillment
    },
    reason => {
      // rejection
    }
  )

• With user defined settings

  import axios from 'axios'
  import retry from 'promise-retyable'
  
  const fn = () => axios('http://someurl')
  
  /**
   default values:
   minWait = 1000,
   maxWait = 30000,
   attempts = 4
  **/
  
  const minWait = 2000,
    maxWait = 10000,
    attempts = 5
  
  retry(minWait, maxWait, attempts)(fn).then(
    ({ value, attempt }) => {
      // fulfillment
    },
    reason => {
      // rejection
    }
  )

You can also inject a backoff function as the last argument with the following signature. The default implementation backs off in multiple of 2 with max time capped at maxWait provided.

function customBackoff(attemptNum, minWait, maxWait) {
  // calculate sleepInterval based on the arguments
  return sleepInterval
}

retry(minWait, maxWait, attempts, customBackoff)(fn).then(
  ({ value, attempt }) => {
    // fulfillment
  },
  reason => {
    // rejection
  }
)

License

MIT. See LICENSE