dwww Home | Show directory contents | Find package

# timed-out [![Build Status](https://travis-ci.org/floatdrop/timed-out.svg?branch=master)](https://travis-ci.org/floatdrop/timed-out)

> Timeout HTTP/HTTPS requests

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


## Usage

```js
const timedOut = require('timed-out');
const http = require('http');
const timedOut = require('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`](https://nodejs.org/api/http.html#http_class_http_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.

Generated by dwww version 1.15 on Wed Jun 26 05:58:00 CEST 2024.