-
Notifications
You must be signed in to change notification settings - Fork 35
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
brodeuralexis
wants to merge
1
commit into
request:master
Choose a base branch
from
brodeuralexis:doc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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); | ||
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; | ||
} | ||
``` | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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