requestretry
Advanced tools
request-retry wrap nodejs request to retry http(s) requests in case of error
The requestretry npm package is a wrapper around the popular request library that adds automatic retry functionality for failed HTTP requests. It allows you to specify retry strategies, including the number of retries, delay between retries, and conditions under which to retry.
Basic HTTP Request with Retry
This feature allows you to make an HTTP GET request with automatic retries. You can specify the maximum number of attempts, the delay between retries, and the retry strategy.
const request = require('requestretry');
request({
url: 'https://api.example.com/data',
method: 'GET',
maxAttempts: 5, // (default) try 5 times
retryDelay: 5000, // (default) wait for 5s before trying again
retryStrategy: request.RetryStrategies.HTTPOrNetworkError // (default) retry on 5xx or network errors
}, function (err, response, body) {
if (err) {
console.error('Failed:', err);
} else {
console.log('Success:', body);
}
});Custom Retry Strategy
This feature allows you to define a custom retry strategy. In this example, the request will be retried if there is an error or if the response status code is 502 (Bad Gateway).
const request = require('requestretry');
function myRetryStrategy(err, response, body) {
// retry the request if we had an error or if the response was a 'Bad Gateway'
return err || response.statusCode === 502;
}
request({
url: 'https://api.example.com/data',
method: 'GET',
maxAttempts: 3,
retryDelay: 3000,
retryStrategy: myRetryStrategy
}, function (err, response, body) {
if (err) {
console.error('Failed:', err);
} else {
console.log('Success:', body);
}
});POST Request with Retry
This feature demonstrates how to make an HTTP POST request with automatic retries. The request includes a JSON body and will retry up to 4 times with a 2-second delay between attempts.
const request = require('requestretry');
request({
url: 'https://api.example.com/data',
method: 'POST',
json: true,
body: { key: 'value' },
maxAttempts: 4,
retryDelay: 2000,
retryStrategy: request.RetryStrategies.HTTPOrNetworkError
}, function (err, response, body) {
if (err) {
console.error('Failed:', err);
} else {
console.log('Success:', body);
}
});axios-retry is a plugin for the axios HTTP client that adds retry functionality. It allows you to specify the number of retries, delay between retries, and conditions for retrying. Compared to requestretry, axios-retry is built on top of axios, which is a more modern and widely-used HTTP client than request.
got-retry is a plugin for the got HTTP client that adds retry functionality. It provides a flexible retry mechanism with customizable options for retry count, delay, and conditions. got-retry is built on top of got, which is known for its simplicity and performance, making it a good alternative to requestretry.
superagent-retry is a plugin for the superagent HTTP client that adds retry functionality. It allows you to specify the number of retries and conditions for retrying requests. superagent-retry is useful if you are already using superagent and need retry capabilities similar to those provided by requestretry.
When the connection fails with one of ECONNRESET, ENOTFOUND, ESOCKETTIMEDOUT, ETIMEDOUT, ECONNREFUSED, EHOSTUNREACH, EPIPE or when an HTTP 5xx error occurrs, the request will automatically be re-attempted as these are often recoverable errors and will go away on retry.
Request-retry is a drop-in replacement for request but adds two new options maxAttempts and retryDelay.
var request = require('requestretry');
request({
url: 'https://api.domain.com/v1/a/b'
json:true,
// The above parameters are specific to Request-retry
maxAttempts: 5, // (default) try 5 times
retryDelay: 5000, // (default) wait for 5s before trying again
retryStrategy: request.RetryStrategies.HTTPOrNetworkError // (default) retry on 5xx or network errors
}, function(err, response, body){
// this callback will only be called when the request succeeded or after maxAttempts or on error
});
Install with npm.
npm install --save requestretry
/**
* @param {Null | Object} err
* @param {Object} response
* @return {Boolean} true if the request should be retried
*/
function myRetryStrategy(err, response){
// retry the request if we had an error or if the response was a 'Bad Gateway'
return err || response.statusCode === 502;
}
request({
url: 'https://api.domain.com/v1/a/b'
json:true,
retryStrategy: myRetryStrategy
}, function(err, response, body){
// this callback will only be called when the request succeeded or after maxAttempts or on error
});
request to 2.51.0request.RetryStrategies.HTTPError, request.RetryStrategies.NetworkError and request.RetryStrategies.HTTPOrNetworkErrorEPIPEEHOSTUNREACHrequest to 2.44.0 (19/09/2014)cancelable as deps.abort() method.Copyright 2014, Francois-Guillaume Ribreau (npm@fgribreau.com)
FAQs
request-retry wrap nodejs request to retry http(s) requests in case of error
The npm package requestretry receives a total of 209,292 weekly downloads. As such, requestretry popularity was classified as popular.
We found that requestretry demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.