Skip to content

doc: fix type of http.request's agent option #9584

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.

Sign up for GitHub

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

Closed
TimothyGu wants to merge 2 commits into from
Closed

doc: fix type of http.request's agent option #9584

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2fd495
doc: fix type of http.request's `agent` option
TimothyGu Nov 12, 2016
0574f02
doc: wrap long lines in http.request
TimothyGu Nov 13, 2016
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
2 changes: 1 addition & 1 deletion doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1518,7 +1518,7 @@ added: v0.3.6
* `headers` {Object} An object containing request headers.
* `auth` {String} Basic authentication i.e. `'user:password'` to compute an
Authorization header.
* `agent` {String} Controls [`Agent`][] behavior. When an Agent is used request will
* `agent` {http.Agent|Boolean} Controls [`Agent`][] behavior. When an Agent is used request will
Copy link
Member

@lpinca lpinca Nov 13, 2016

Choose a reason for hiding this comment

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

Nit: long line. Please wrap it at 80 chars if you can.

default to `Connection: keep-alive`. Possible values:
* `undefined` (default): use [`http.globalAgent`][] for this host and port.
* `Agent` object: explicitly use the passed in `Agent`.
Expand Down