retry-request
Advanced tools
Package description
The retry-request npm package is designed to make it easier to handle network requests that might need to be retried due to failures or errors. It wraps around the standard request functionality, providing a way to automatically retry requests a specified number of times, with customizable intervals between retries. This is particularly useful in environments where network reliability can't always be guaranteed, or when dealing with services that might occasionally fail or be temporarily unavailable.
Basic retry functionality
This demonstrates how to use retry-request to make a simple HTTP request with retry functionality. If the request fails, retry-request will automatically retry the request based on its default configuration.
const retryRequest = require('retry-request');
const requestOptions = {
url: 'http://example.com'
};
retryRequest(requestOptions, function(err, response, body) {
if (!err) {
console.log(body);
}
});Custom retry options
This example shows how to customize the retry behavior, including the number of retries, the delay between retries, and even specifying a custom request module to use for the actual HTTP requests.
const retryRequest = require('retry-request');
const requestOptions = {
url: 'http://example.com'
};
const options = {
retries: 5,
request: require('request'),
retryDelay: 1000
};
retryRequest(requestOptions, options, function(err, response, body) {
if (!err) {
console.log(body);
}
});axios-retry is a package that adds retry functionality to Axios requests. It is similar to retry-request but is specifically designed for use with Axios, a promise-based HTTP client, offering more modern syntax and promise support compared to the callback-based retry-request.
got is a more comprehensive HTTP request library that includes built-in retry functionality among many other features. Unlike retry-request, which is a wrapper around the request library, got is a standalone library offering a wide range of HTTP capabilities, including retries, which makes it a more versatile choice for complex applications.
superagent-retry extends the superagent library with retry capabilities. It is similar to retry-request in that it adds retry functionality to an existing HTTP request library, but it is tailored for superagent users. This package is a good choice for those already using superagent and looking to add simple retry mechanisms.
Readme
 |
|---|
| Retry a request with built-in exponential backoff. |
$ npm install --save retry-request
var request = require('retry-request');
It should work the same as request in both callback mode and stream mode.
Note: This module only works when used as a readable stream, i.e. POST requests aren't supported (#3).
urlThatReturns503 will be requested 3 total times before giving up and executing the callback.
request(urlThatReturns503, function (err, resp, body) {});
urlThatReturns503 will be requested 3 total times before giving up and emitting the response and complete event as usual.
request(urlThatReturns503)
.on('error', function () {})
.on('response', function () {})
.on('complete', function () {});
Passed directly to request. See the list of options supported: https://github.com/request/request/#requestoptions-callback.
opts.noResponseRetriesType: Number
Default: 2
The number of times to retry after a response fails to come through, such as a DNS resolution error or a socket hangup.
var opts = {
noResponseRetries: 0
};
request(url, opts, function (err, resp, body) {
// url was requested 1 time before giving up and
// executing this callback.
});
opts.objectModeType: Boolean
Default: false
Set to true if your custom opts.request function returns a stream in object mode.
opts.retriesType: Number
Default: 2
var opts = {
retries: 4
};
request(urlThatReturns503, opts, function (err, resp, body) {
// urlThatReturns503 was requested a total of 5 times
// before giving up and executing this callback.
});
opts.currentRetryAttemptType: Number
Default: 0
var opts = {
currentRetryAttempt: 1
};
request(urlThatReturns503, opts, function (err, resp, body) {
// urlThatReturns503 was requested as if it already failed once.
});
opts.shouldRetryFnType: Function
Default: Returns true if http.incomingMessage.statusCode is < 200 or >= 400.
var opts = {
shouldRetryFn: function (incomingHttpMessage) {
return incomingHttpMessage.statusMessage !== 'OK';
}
};
request(urlThatReturnsNonOKStatusMessage, opts, function (err, resp, body) {
// urlThatReturnsNonOKStatusMessage was requested a
// total of 3 times, each time using `opts.shouldRetryFn`
// to decide if it should continue before giving up and
// executing this callback.
});
opts.requestType: Function
Default: request
NOTE: If you override the request function, and it returns a stream in object mode, be sure to set opts.objectMode to true.
var originalRequest = require('request').defaults({
pool: {
maxSockets: Infinity
}
});
var opts = {
request: originalRequest
};
request(urlThatReturns503, opts, function (err, resp, body) {
// Your provided `originalRequest` instance was used.
});
Passed directly to request. See the callback section: https://github.com/request/request/#requestoptions-callback.
FAQs
Retry a request.
The npm package retry-request receives a total of 5,403,145 weekly downloads. As such, retry-request popularity was classified as popular.
We found that retry-request demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers 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
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.
Security News
Researchers have demonstrated that teams of LLM agents can exploit zero-day vulnerabilities with a 53% success rate, and the costs of using AI to do so are rapidly becoming more affordable than hiring a human penetration tester.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.