connect-timeout

What is connect-timeout?

The connect-timeout npm package is a middleware for Connect/Express applications that allows you to set a timeout for HTTP requests. If a request takes longer than the specified timeout, it will be aborted and a timeout error will be sent to the client.

What are connect-timeout's main functionalities?

Setting a basic timeout

This feature allows you to set a basic timeout for all incoming HTTP requests. If a request takes longer than the specified time (in this case, 5 seconds), it will be aborted and a timeout error will be sent to the client.

const express = require('express');
const timeout = require('connect-timeout');

const app = express();

// Set a timeout of 5 seconds
app.use(timeout('5s'));

app.get('/', (req, res) => {
  // Simulate a long-running request
  setTimeout(() => {
    res.send('Hello, world!');
  }, 6000);
});

app.use((err, req, res, next) => {
  if (req.timedout) {
    res.status(503).send('Service unavailable. Please try again later.');
  } else {
    next(err);
  }
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Custom timeout handler

This feature allows you to define a custom timeout handler. If a request times out, the custom handler will send a specific message to the client.

const express = require('express');
const timeout = require('connect-timeout');

const app = express();

// Set a timeout of 5 seconds
app.use(timeout('5s'));

app.get('/', (req, res) => {
  // Simulate a long-running request
  setTimeout(() => {
    res.send('Hello, world!');
  }, 6000);
});

// Custom timeout handler
app.use((req, res, next) => {
  if (req.timedout) {
    res.status(503).send('Custom timeout message: Service unavailable.');
  } else {
    next();
  }
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Conditional timeout

This feature allows you to set a conditional timeout based on the request path. In this example, the '/slow' endpoint has a longer timeout of 10 seconds, while other endpoints do not have a timeout.

const express = require('express');
const timeout = require('connect-timeout');

const app = express();

// Set a conditional timeout
app.use((req, res, next) => {
  if (req.path === '/slow') {
    timeout('10s')(req, res, next);
  } else {
    next();
  }
});

app.get('/slow', (req, res) => {
  // Simulate a long-running request
  setTimeout(() => {
    res.send('This is a slow endpoint.');
  }, 11000);
});

app.get('/fast', (req, res) => {
  res.send('This is a fast endpoint.');
});

app.use((err, req, res, next) => {
  if (req.timedout) {
    res.status(503).send('Service unavailable. Please try again later.');
  } else {
    next(err);
  }
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Other packages similar to connect-timeout

express-timeout-handler

The express-timeout-handler package provides similar functionality to connect-timeout by allowing you to set timeouts for HTTP requests in Express applications. It also offers more advanced features such as custom error messages and different timeout strategies. Compared to connect-timeout, express-timeout-handler provides more flexibility and customization options.

express-timeout

The express-timeout package is another middleware for setting timeouts in Express applications. It is simpler and more lightweight compared to connect-timeout, making it a good choice for projects that require basic timeout functionality without additional features.

README

Timeout

Previously connect.timeout().

Usage:

var app = require('connect');
app.use(require('timeout')(300))

API

fn = timeout(ms)

Returns middleware that times out in ms milliseconds.

License

The MIT License (MIT)

Copyright (c) 2014 Jonathan Ong [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.