Installations

npm install express-timeout-handler

Pull Requests

Open

1

Total

10

Closed

4

Merged

5

Issues

Open

1

Total

1

Closed

0

Releases

1

v2.2.0

Published on 04 Jul 2019

View all 1 releases

Developer

debitoor

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=6.0.0

Typescript Support

No

Node Version

14.15.4

NPM Version

6.14.11 Statistics

17 Stars

54 Commits

4 Forks

25 Watching

7 Branches

36 Contributors

Updated on 23 Nov 2021

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

7,167,019

Last day

-11.3%

6,599

Compared to previous day

Last week

-8.3%

37,865

Compared to previous week

Last month

16.2%

181,738

Compared to previous month

Last year

-32.3%

1,254,770

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

9

chai coveralls express istanbul jscs mocha mocha-eslint mocha-jscs request

Versions

express-timeout-handler

Express timeout middleware that ensures a response is returned to the client on a timeout event.

Add a global timeout to all your routes in express and add individual timeouts to specific routes. If a timeout happens the onTimeout function will be called. The onTimeout function MUST terminate the request with a response. When a timeout happens, this module will set a globalTimeout property on the response object to true and disable all methods on the response object which might try and send something after the timeout happened.

Note on streams: whenever a stream has started streaming to the response object, the onTimeout function will not be triggered. Or in other words: if a timeout happens after we start streaming, the stream will not be interrupted.

npm install --save express-timeout-handler

Usage

1var timeout = require('express-timeout-handler');
2var express = require('express');
3var app = express();
4
5var options = {
6
7  // Optional. This will be the default timeout for all endpoints.
8  // If omitted there is no default timeout on endpoints
9  timeout: 3000,
10
11  // Optional. This function will be called on a timeout and it MUST
12  // terminate the request.
13  // If omitted the module will end the request with a default 503 error.
14  onTimeout: function(req, res) {
15    res.status(503).send('Service unavailable. Please retry.');
16  },
17
18  // Optional. Define a function to be called if an attempt to send a response
19  // happens after the timeout where:
20  // - method: is the method that was called on the response object
21  // - args: are the arguments passed to the method
22  // - requestTime: is the duration of the request
23  // timeout happened
24  onDelayedResponse: function(req, method, args, requestTime) {
25    console.log(`Attempted to call ${method} after timeout`);
26  },
27
28  // Optional. Provide a list of which methods should be disabled on the
29  // response object when a timeout happens and an error has been sent. If
30  // omitted, a default list of all methods that tries to send a response
31  // will be disable on the response object
32  disable: ['write', 'setHeaders', 'send', 'json', 'end'];
33};
34
35app.use(timeout.handler(options));
36
37app.get('/greet', //The default timeout is in effect here
38  function (req, res) {
39    res.send('Hello world!');
40  }
41);
42
43app.get('/leave',
44  // This is a specific endpoint timeout which overrides the default timeout
45  timeout.set(4000),
46  function (req, res) {
47    res.send('Goodbye!');
48  }
49);
50
51app.listen(3000, function () {
52  console.log('Server listening on port 3000');
53});

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

43 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-x55w-vjjp-222r
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.4

/10

Last Scanned on 2024-11-25

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