Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic documentation #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,39 @@
forever-agent
=============
# forever-agent

HTTP Agent that keeps socket connections alive between keep-alive requests. Formerly part of mikeal/request, now a standalone module.
HTTP Agent that keeps socket connections alive between keep-alive requests.
Formerly part of mikeal/request, now a standalone module.

## Installation

`forever-agent` can be installed with npm:
```bash
npm install forever-agent [--save]
```

## Usage

The `ForeverAgent` and `ForeverAgent.SSL` are classes that extend `http.Agent`
and `https.Agent` respectively.

Many popular request libraries already support `forever-agent` out of the box,
but global usage can be achieved with the following code snippet:

```js
var ForeverAgent = require("forever-agent");
var http = require("http");
var https = require("https");

var options = {};
http.globalAgent = new ForeverAgent(options);

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this actually works?
Have you checked that http.globalAgent can be replaced?
nodejs/node#9057

https.globalAgent = new ForeverAgent.SSL(options);
```
where `options` is like the following:
```ts
interface Options {
// Maximum number of sockets to allow per host.
maxSockets?: number;
// Minimum amount of sockets that should be retained.
minSockets?: number;
}
```