timed-out

What is timed-out?

The 'timed-out' npm package is used to timeout HTTP requests. It provides a simple way to set timeouts for various stages of an HTTP request, such as the connection, socket, and response stages.

What are timed-out's main functionalities?

Set timeout for HTTP request

This feature allows you to set a timeout for an HTTP request. In this example, a timeout of 5 seconds is set for the HTTP GET request to 'http://example.com'. If the request takes longer than 5 seconds, it will be aborted.

const http = require('http');
const timedOut = require('timed-out');

const req = http.get('http://example.com', (res) => {
  // Handle response
});

// Set a timeout of 5 seconds
const timeout = 5000;
timedOut(req, timeout);

Set timeout for specific stages

This feature allows you to set timeouts for specific stages of an HTTP request. In this example, different timeouts are set for the connection, socket, and response stages of the HTTP GET request to 'http://example.com'.

const http = require('http');
const timedOut = require('timed-out');

const req = http.get('http://example.com', (res) => {
  // Handle response
});

// Set timeouts for different stages
const options = {
  connect: 1000, // 1 second for connection
  socket: 2000,  // 2 seconds for socket
  response: 3000 // 3 seconds for response
};
timedOut(req, options);

Other packages similar to timed-out

axios

Axios is a promise-based HTTP client for the browser and Node.js. It allows you to set timeouts for requests and provides a more comprehensive set of features for making HTTP requests compared to 'timed-out'.

request

Request is a simplified HTTP client that supports timeouts and many other features. It is more feature-rich than 'timed-out' and provides a higher-level API for making HTTP requests.

got

Got is a human-friendly and powerful HTTP request library for Node.js. It supports timeouts and provides a more modern and flexible API compared to 'timed-out'.

README

timed-out

Timeout HTTP/HTTPS requests

Emits Error object with code property equal ETIMEDOUT or ESOCKETTIMEDOUT when ClientRequest is hanged.

Usage

import http from 'node:http';
import timedOut from 'timed-out';

const request = http.get('http://www.google.ru');
timedOut(request, 2000); // Sets a 2 seconds limit

API

timedout(request, time)

request

Required Type: ClientRequest

The request to watch.

time

Required Type: number | object

Time in milliseconds to wait for a connect event on the socket and also time to wait on inactive socket.

Or you can pass an object with the following fields:

• connect - Time to wait for a connection.
• socket - Time to wait for activity on the socket.

timed-out for enterprise

Available as part of the Tidelift Subscription.

The maintainers of timed-out and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.