Gathering detailed insights and metrics for retry-request
Gathering detailed insights and metrics for retry-request
**THIS REPOSITORY AND PACKAGE WILL BE DEPRECATED IN JULY 2024** Retry a request with built-in exponential backoff.
Installations
npm install retry-requestDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
>=18
Node Version
14.21.3
NPM Version
6.14.18
Releases
13
Languages
2
JavaScript
Python
JavaScript (96.84%)
Python (3.16%)
Developer
stephenplusplus
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
67 Stars
181 Commits
16 Forks
50 Watchers
16 Branches
977 Contributors
Updated on Jun 18, 2025
Maintainers
2
Package Meta Information
Latest Version
8.0.0
Package Id
retry-request@8.0.0
Unpacked Size
20.68 kB
Size
6.71 kB
File Count
6
NPM Version
6.14.18
Node Version
14.21.3
Published on
Feb 19, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
THIS REPOSITORY AND PACKAGE WILL BE DEPRECATED IN JULY 2024. RELEVANT FUNCTIONALITIES HAVE BEEN MOVED TO GOOGLEAPIS/GAXIOS
 |
|---|
| Retry a request with built-in exponential backoff. |
1$ npm install --save teeny-request 2$ npm install --save retry-request
1var request = require('retry-request', { 2 request: require('teeny-request'), 3});
It should work the same as request and teeny-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).
Do I need to install request?
Yes! You must independently install teeny-request OR request (deprecated) and provide it to this library:
1var request = require('retry-request', { 2 request: require('teeny-request'), 3});
Callback
urlThatReturns503 will be requested 3 total times before giving up and executing the callback.
1request(urlThatReturns503, function (err, resp, body) {});
Stream
urlThatReturns503 will be requested 3 total times before giving up and emitting the response and complete event as usual.
1request(urlThatReturns503) 2 .on('error', function () {}) 3 .on('response', function () {}) 4 .on('complete', function () {});
Can I monitor what retry-request is doing internally?
Yes! To enable the debug mode, set the environment variable DEBUG to retry-request.
(Thanks for the implementation, @yihaozhadan!)
request(requestOptions, [opts], [cb])
requestOptions
Passed directly to request or teeny-request. See the list of options supported:
- https://github.com/request/request/#requestoptions-callback
- https://github.com/googleapis/teeny-request#teenyrequestoptions-callback
opts (optional)
opts.noResponseRetries
Type: 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.
1var opts = { 2 noResponseRetries: 0, 3}; 4 5request(url, opts, function (err, resp, body) { 6 // url was requested 1 time before giving up and 7 // executing this callback. 8});
opts.objectMode
Type: Boolean
Default: false
Set to true if your custom opts.request function returns a stream in object mode.
opts.retries
Type: Number
Default: 2
1var opts = { 2 retries: 4, 3}; 4 5request(urlThatReturns503, opts, function (err, resp, body) { 6 // urlThatReturns503 was requested a total of 5 times 7 // before giving up and executing this callback. 8});
opts.currentRetryAttempt
Type: Number
Default: 0
1var opts = { 2 currentRetryAttempt: 1, 3}; 4 5request(urlThatReturns503, opts, function (err, resp, body) { 6 // urlThatReturns503 was requested as if it already failed once. 7});
opts.shouldRetryFn
Type: Function
Default: Returns true if http.incomingMessage.statusCode is < 200 or >= 400.
1var opts = { 2 shouldRetryFn: function (incomingHttpMessage) { 3 return incomingHttpMessage.statusMessage !== 'OK'; 4 }, 5}; 6 7request(urlThatReturnsNonOKStatusMessage, opts, function (err, resp, body) { 8 // urlThatReturnsNonOKStatusMessage was requested a 9 // total of 3 times, each time using `opts.shouldRetryFn` 10 // to decide if it should continue before giving up and 11 // executing this callback. 12});
opts.request
Type: Function
If we not provided we will throw an error advising you to provide it.
NOTE: If you override the request function, and it returns a stream in object mode, be sure to set opts.objectMode to true.
1var originalRequest = require('teeny-request').defaults({ 2 pool: { 3 maxSockets: Infinity, 4 }, 5}); 6 7var opts = { 8 request: originalRequest, 9}; 10 11request(urlThatReturns503, opts, function (err, resp, body) { 12 // Your provided `originalRequest` instance was used. 13});
opts.maxRetryDelay
Type: Number
Default: 64
The maximum time to delay in seconds. If retryDelayMultiplier results in a delay greater than maxRetryDelay, retries should delay by maxRetryDelay seconds instead.
opts.retryDelayMultiplier
Type: Number
Default: 2
The multiplier by which to increase the delay time between the completion of failed requests, and the initiation of the subsequent retrying request.
opts.totalTimeout
Type: Number
Default: 600
The length of time to keep retrying in seconds. The last sleep period will be shortened as necessary, so that the last retry runs at deadline (and not considerably beyond it). The total time starting from when the initial request is sent, after which an error will be returned, regardless of the retrying attempts made meanwhile.
cb (optional)
Passed directly to request. See the callback section: https://github.com/request/request/#requestoptions-callback.
No vulnerabilities found.
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
Found 17/18 approved changesets -- score normalized to 9
Reason
SAST tool is not run on all commits -- score normalized to 2
Details
- Warn: 8 commits out of 30 are checked with a SAST tool
Reason
1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yaml:1
- Warn: no topLevel permission defined: .github/workflows/issues-no-repro.yaml:1
- Warn: no topLevel permission defined: .github/workflows/response.yaml:1
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issues-no-repro.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/issues-no-repro.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issues-no-repro.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/issues-no-repro.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issues-no-repro.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/issues-no-repro.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/response.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/response.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/googleapis/retry-request/response.yaml/main?enable=pin
- Warn: npmCommand not pinned by hash: .kokoro/docs.sh:23
- Warn: npmCommand not pinned by hash: .kokoro/lint.sh:23
- Warn: npmCommand not pinned by hash: .kokoro/lint.sh:29
- Warn: npmCommand not pinned by hash: .kokoro/publish.sh:29
- Warn: npmCommand not pinned by hash: .kokoro/release/docs-devsite.sh:27
- Warn: npmCommand not pinned by hash: .kokoro/release/docs-devsite.sh:28
- Warn: npmCommand not pinned by hash: .kokoro/release/docs.sh:27
- Warn: npmCommand not pinned by hash: .kokoro/release/docs.sh:31
- Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:21
- Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:37
- Warn: npmCommand not pinned by hash: .kokoro/samples-test.sh:42
- Warn: npmCommand not pinned by hash: .kokoro/system-test.sh:34
- Warn: npmCommand not pinned by hash: .kokoro/test.sh:23
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:23
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:26
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:38
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:62
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yaml:71
- Warn: npmCommand not pinned by hash: .github/workflows/issues-no-repro.yaml:18
- Info: 0 out of 17 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 19 npmCommand dependencies pinned
Score
5.6
/10
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More