lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: http cleanup and missing argument types 

Ref: https://github.com/nodejs/node/issues/9399
PR-URL: https://github.com/nodejs/node/pull/11681
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
v7.x
Amelia Clarke 8 years ago
committed by Italo A. Casas
parent
734ddbe77b
commit
a20aa0ee48
No known key found for this signature in database GPG Key ID: 23EFEFE93C4CFFFE
1 changed files with 82 additions and 81 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 163
      doc/api/http.md

163
doc/api/http.md
View File

@ -73,9 +73,9 @@ It is good practice, to [`destroy()`][] an `Agent` instance when it is no
longer in use, because unused sockets consume OS resources. longer in use, because unused sockets consume OS resources.
Sockets are removed from an agent's pool when the socket emits either Sockets are removed from an agent's pool when the socket emits either
a `'close'` event or an `'agentRemove'` event. This means that if a `'close'` event or an `'agentRemove'` event. When intending to keep one
you intend to keep one HTTP request open for a long time and don't HTTP request open for a long time without keeping it in the pool, something
want it to stay in the pool you can do something along the lines of: like the following may be done:
```js ```js
http.get(options, (res) => { http.get(options, (res) => {
@ -85,7 +85,7 @@ http.get(options, (res) => {
}); });
``` ```
You may also use an agent for an individual request. By providing An agent may also be used for an individual request. By providing
`{agent: false}` as an option to the `http.get()` or `http.request()` `{agent: false}` as an option to the `http.get()` or `http.request()`
functions, a one-time use `Agent` with default options will be used functions, a one-time use `Agent` with default options will be used
for the client connection. for the client connection.
@ -112,21 +112,21 @@ added: v0.3.4
Can have the following fields: Can have the following fields:
* `keepAlive` {boolean} Keep sockets around even when there are no * `keepAlive` {boolean} Keep sockets around even when there are no
outstanding requests, so they can be used for future requests without outstanding requests, so they can be used for future requests without
having to reestablish a TCP connection. Default = `false` having to reestablish a TCP connection. Defaults to `false`
* `keepAliveMsecs` {Integer} When using the `keepAlive` option, specifies * `keepAliveMsecs` {number} When using the `keepAlive` option, specifies
the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay) the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay)
for TCP Keep-Alive packets. Ignored when the for TCP Keep-Alive packets. Ignored when the
`keepAlive` option is `false` or `undefined`. Default = `1000`. `keepAlive` option is `false` or `undefined`. Defaults to `1000`.
* `maxSockets` {number} Maximum number of sockets to allow per * `maxSockets` {number} Maximum number of sockets to allow per
host. Default = `Infinity`. host. Defaults to `Infinity`.
* `maxFreeSockets` {number} Maximum number of sockets to leave open * `maxFreeSockets` {number} Maximum number of sockets to leave open
in a free state. Only relevant if `keepAlive` is set to `true`. in a free state. Only relevant if `keepAlive` is set to `true`.
Default = `256`. Defaults to `256`.
The default [`http.globalAgent`][] that is used by [`http.request()`][] has all The default [`http.globalAgent`][] that is used by [`http.request()`][] has all
of these values set to their respective defaults. of these values set to their respective defaults.
To configure any of them, you must create your own [`http.Agent`][] instance. To configure any of them, a custom [`http.Agent`][] instance must be created.
```js ```js
const http = require('http'); const http = require('http');
@ -162,9 +162,9 @@ added: v0.11.4
Destroy any sockets that are currently in use by the agent. Destroy any sockets that are currently in use by the agent.
It is usually not necessary to do this. However, if you are using an It is usually not necessary to do this. However, if using an
agent with `keepAlive` enabled, then it is best to explicitly shut down agent with `keepAlive` enabled, then it is best to explicitly shut down
the agent when you know that it will no longer be used. Otherwise, the agent when it will no longer be used. Otherwise,
sockets may hang open for quite a long time before the server sockets may hang open for quite a long time before the server
terminates them. terminates them.
@ -188,7 +188,7 @@ added: v0.11.4
* `port` {number} Port of remote server * `port` {number} Port of remote server
* `localAddress` {string} Local interface to bind for network connections * `localAddress` {string} Local interface to bind for network connections
when issuing the request when issuing the request
* Returns: {String} * Returns: {string}
Get a unique name for a set of request options, to determine whether a Get a unique name for a set of request options, to determine whether a
connection can be reused. For an HTTP agent, this returns connection can be reused. For an HTTP agent, this returns
@ -201,7 +201,7 @@ socket reusability.
added: v0.11.7 added: v0.11.7
--> -->
* {Number} * {number}
By default set to 256. For agents with `keepAlive` enabled, this By default set to 256. For agents with `keepAlive` enabled, this
sets the maximum number of sockets that will be left open in the free sets the maximum number of sockets that will be left open in the free
@ -212,7 +212,7 @@ state.
added: v0.3.6 added: v0.3.6
--> -->
* {Number} * {number}
By default set to Infinity. Determines how many concurrent sockets the agent By default set to Infinity. Determines how many concurrent sockets the agent
can have open per origin. Origin is either a 'host:port' or can have open per origin. Origin is either a 'host:port' or
@ -258,8 +258,8 @@ During the [`'response'`][] event, one can add listeners to the
response object; particularly to listen for the `'data'` event. response object; particularly to listen for the `'data'` event.
If no [`'response'`][] handler is added, then the response will be If no [`'response'`][] handler is added, then the response will be
entirely discarded. However, if you add a [`'response'`][] event handler, entirely discarded. However, if a [`'response'`][] event handler is added,
then you **must** consume the data from the response object, either by then the data from the response object **must** be consumed, either by
calling `response.read()` whenever there is a `'readable'` event, or calling `response.read()` whenever there is a `'readable'` event, or
by adding a `'data'` handler, or by calling the `.resume()` method. by adding a `'data'` handler, or by calling the `.resume()` method.
Until the data is consumed, the `'end'` event will not fire. Also, until Until the data is consumed, the `'end'` event will not fire. Also, until
@ -301,7 +301,7 @@ Emitted each time a server responds to a request with a `CONNECT` method. If thi
event is not being listened for, clients receiving a `CONNECT` method will have event is not being listened for, clients receiving a `CONNECT` method will have
their connections closed. their connections closed.
A client and server pair that shows you how to listen for the `'connect'` event: A client and server pair demonstrating how to listen for the `'connect'` event:
```js ```js
const http = require('http'); const http = require('http');
@ -399,7 +399,7 @@ Emitted each time a server responds to a request with an upgrade. If this
event is not being listened for, clients receiving an upgrade header will have event is not being listened for, clients receiving an upgrade header will have
their connections closed. their connections closed.
A client server pair that show you how to listen for the `'upgrade'` event. A client server pair demonstrating how to listen for the `'upgrade'` event.
```js ```js
const http = require('http'); const http = require('http');
@ -484,13 +484,13 @@ added: v1.6.0
Flush the request headers. Flush the request headers.
For efficiency reasons, Node.js normally buffers the request headers until you For efficiency reasons, Node.js normally buffers the request headers until
call `request.end()` or write the first chunk of request data. It then tries `request.end()` is called or the first chunk of request data is written. It
hard to pack the request headers and data into a single TCP packet. then tries to pack the request headers and data into a single TCP packet.
That's usually what you want (it saves a TCP round-trip) but not when the first That's usually desired (it saves a TCP round-trip), but not when the first
data is not sent until possibly much later. `request.flushHeaders()` lets you bypass data is not sent until possibly much later. `request.flushHeaders()` bypasses
the optimization and kickstart the request. the optimization and kickstarts the request.
### request.setNoDelay([noDelay]) ### request.setNoDelay([noDelay])
<!-- YAML <!-- YAML
@ -536,7 +536,7 @@ added: v0.1.29
* `callback` {Function} * `callback` {Function}
Sends a chunk of the body. By calling this method Sends a chunk of the body. By calling this method
many times, the user can stream a request body to a many times, a request body can be sent to a
server--in that case it is suggested to use the server--in that case it is suggested to use the
`['Transfer-Encoding', 'chunked']` header line when `['Transfer-Encoding', 'chunked']` header line when
creating the request. creating the request.
@ -653,7 +653,7 @@ not listened for, then clients requesting a `CONNECT` method will have their
connections closed. connections closed.
After this event is emitted, the request's socket will not have a `'data'` After this event is emitted, the request's socket will not have a `'data'`
event listener, meaning you will need to bind to it in order to handle data event listener, meaning it will need to be bound in order to handle data
sent to the server on that socket. sent to the server on that socket.
### Event: 'connection' ### Event: 'connection'
@ -695,7 +695,7 @@ listened for, then clients requesting an upgrade will have their connections
closed. closed.
After this event is emitted, the request's socket will not have a `'data'` After this event is emitted, the request's socket will not have a `'data'`
event listener, meaning you will need to bind to it in order to handle data event listener, meaning it will need to be bound in order to handle data
sent to the server on that socket. sent to the server on that socket.
### server.close([callback]) ### server.close([callback])
@ -774,7 +774,7 @@ after the `'listening'` event has been emitted.
To listen to a unix socket, supply a filename instead of port and hostname. To listen to a unix socket, supply a filename instead of port and hostname.
`backlog` is the maximum length of the queue of pending connections. `backlog` is the maximum length of the queue of pending connections.
The actual length will be determined by your OS through sysctl settings such as The actual length will be determined by the OS through sysctl settings such as
`tcp_max_syn_backlog` and `somaxconn` on linux. The default value of this `tcp_max_syn_backlog` and `somaxconn` on linux. The default value of this
parameter is 511 (not 512). parameter is 511 (not 512).
@ -789,27 +789,27 @@ subsequent call will *re-open* the server using the provided options.
added: v5.7.0 added: v5.7.0
--> -->
* {Boolean} * {boolean}
A Boolean indicating whether or not the server is listening for A Boolean indicating whether or not the server is listening for
connections. connections.
### server.maxHeadersCount ### server.maxHeadersCount([limit])
<!-- YAML <!-- YAML
added: v0.7.0 added: v0.7.0
--> -->
* {Number} * `limit` {number} Defaults to 1000.
Limits maximum incoming headers count, equal to 1000 by default. If set to 0 - Limits maximum incoming headers count, equal to 1000 by default. If set to 0 -
no limit will be applied. no limit will be applied.
### server.setTimeout(msecs, callback) ### server.setTimeout([msecs][, callback])
<!-- YAML <!-- YAML
added: v0.9.12 added: v0.9.12
--> -->
* `msecs` {number} * `msecs` {number} Defaults to 120000 (2 minutes).
* `callback` {Function} * `callback` {Function}
Sets the timeout value for sockets, and emits a `'timeout'` event on Sets the timeout value for sockets, and emits a `'timeout'` event on
@ -820,18 +820,17 @@ If there is a `'timeout'` event listener on the Server object, then it
will be called with the timed-out socket as an argument. will be called with the timed-out socket as an argument.
By default, the Server's timeout value is 2 minutes, and sockets are By default, the Server's timeout value is 2 minutes, and sockets are
destroyed automatically if they time out. However, if you assign a destroyed automatically if they time out. However, if a callback is assigned
callback to the Server's `'timeout'` event, then you are responsible to the Server's `'timeout'` event, timeouts must be handled explicitly.
for handling socket timeouts.
Returns `server`. Returns `server`.
### server.timeout ### server.timeout([msecs])
<!-- YAML <!-- YAML
added: v0.9.12 added: v0.9.12
--> -->
* {Number} Default = 120000 (2 minutes) * `msecs` {number} Defaults to 120000 (2 minutes).
The number of milliseconds of inactivity before a socket is presumed The number of milliseconds of inactivity before a socket is presumed
to have timed out. to have timed out.
@ -888,7 +887,7 @@ Trailers will **only** be emitted if chunked encoding is used for the
response; if it is not (e.g. if the request was HTTP/1.0), they will response; if it is not (e.g. if the request was HTTP/1.0), they will
be silently discarded. be silently discarded.
Note that HTTP requires the `Trailer` header to be sent if you intend to Note that HTTP requires the `Trailer` header to be sent in order to
emit trailers, with a list of the header fields in its value. E.g., emit trailers, with a list of the header fields in its value. E.g.,
```js ```js
@ -926,7 +925,7 @@ is finished.
added: v0.0.2 added: v0.0.2
--> -->
* {Boolean} * {boolean}
Boolean value that indicates whether the response has completed. Starts Boolean value that indicates whether the response has completed. Starts
as `false`. After [`response.end()`][] executes, the value will be `true`. as `false`. After [`response.end()`][] executes, the value will be `true`.
@ -937,7 +936,7 @@ added: v0.4.0
--> -->
* `name` {string} * `name` {string}
* Returns: {String} * Returns: {string}
Reads out a header that's already been queued but not sent to the client. Reads out a header that's already been queued but not sent to the client.
Note that the name is case insensitive. Note that the name is case insensitive.
@ -996,8 +995,8 @@ var headers = response.getHeaders();
added: v7.7.0 added: v7.7.0
--> -->
* `name` {String} * `name` {string}
* Returns: {Boolean} * Returns: {boolean}
Returns `true` if the header identified by `name` is currently set in the Returns `true` if the header identified by `name` is currently set in the
outgoing headers. Note that the header name matching is case-insensitive. outgoing headers. Note that the header name matching is case-insensitive.
@ -1013,7 +1012,7 @@ var hasContentType = response.hasHeader('content-type');
added: v0.9.3 added: v0.9.3
--> -->
* {Boolean} * {boolean}
Boolean (read-only). True if headers were sent, false otherwise. Boolean (read-only). True if headers were sent, false otherwise.
@ -1037,7 +1036,7 @@ response.removeHeader('Content-Encoding');
added: v0.7.5 added: v0.7.5
--> -->
* {Boolean} * {boolean}
When true, the Date header will be automatically generated and sent in When true, the Date header will be automatically generated and sent in
the response if it is not already present in the headers. Defaults to true. the response if it is not already present in the headers. Defaults to true.
@ -1051,11 +1050,11 @@ added: v0.4.0
--> -->
* `name` {string} * `name` {string}
* `value` {string} * `value` {string | string[]}
Sets a single header value for implicit headers. If this header already exists Sets a single header value for implicit headers. If this header already exists
in the to-be-sent headers, its value will be replaced. Use an array of strings in the to-be-sent headers, its value will be replaced. Use an array of strings
here if you need to send multiple headers with the same name. here to send multiple headers with the same name.
Example: Example:
@ -1086,7 +1085,7 @@ const server = http.createServer((req,res) => {
}); });
``` ```
### response.setTimeout(msecs, callback) ### response.setTimeout(msecs[, callback])
<!-- YAML <!-- YAML
added: v0.9.12 added: v0.9.12
--> -->
@ -1099,10 +1098,9 @@ provided, then it is added as a listener on the `'timeout'` event on
the response object. the response object.
If no `'timeout'` listener is added to the request, the response, or If no `'timeout'` listener is added to the request, the response, or
the server, then sockets are destroyed when they time out. If you the server, then sockets are destroyed when they time out. If a handler is
assign a handler on the request, the response, or the server's assigned to the request, the response, or the server's `'timeout'` events,
`'timeout'` events, then it is your responsibility to handle timed out timed out sockets must be handled explicitly.
sockets.
Returns `response`. Returns `response`.
@ -1111,7 +1109,7 @@ Returns `response`.
added: v0.4.0 added: v0.4.0
--> -->
* {Number} * {number}
When using implicit headers (not calling [`response.writeHead()`][] explicitly), When using implicit headers (not calling [`response.writeHead()`][] explicitly),
this property controls the status code that will be sent to the client when this property controls the status code that will be sent to the client when
@ -1131,7 +1129,7 @@ status code which was sent out.
added: v0.11.8 added: v0.11.8
--> -->
* {String} * {string}
When using implicit headers (not calling [`response.writeHead()`][] explicitly), this property When using implicit headers (not calling [`response.writeHead()`][] explicitly), this property
controls the status message that will be sent to the client when the headers get controls the status message that will be sent to the client when the headers get
@ -1155,7 +1153,7 @@ added: v0.1.29
* `chunk` {string|Buffer} * `chunk` {string|Buffer}
* `encoding` {string} * `encoding` {string}
* `callback` {Function} * `callback` {Function}
* Returns: {Boolean} * Returns: {boolean}
If this method is called and [`response.writeHead()`][] has not been called, If this method is called and [`response.writeHead()`][] has not been called,
it will switch to implicit header mode and flush the implicit headers. it will switch to implicit header mode and flush the implicit headers.
@ -1172,10 +1170,10 @@ of data is flushed.
higher-level multi-part body encodings that may be used. higher-level multi-part body encodings that may be used.
The first time [`response.write()`][] is called, it will send the buffered The first time [`response.write()`][] is called, it will send the buffered
header information and the first body to the client. The second time header information and the first chunk of the body to the client. The second
[`response.write()`][] is called, Node.js assumes you're going to be streaming time [`response.write()`][] is called, Node.js assumes data will be streamed,
data, and sends that separately. That is, the response is buffered up to the and sends the new data separately. That is, the response is buffered up to the
first chunk of body. first chunk of the body.
Returns `true` if the entire data was flushed successfully to the kernel Returns `true` if the entire data was flushed successfully to the kernel
buffer. Returns `false` if all or part of the data was queued in user memory. buffer. Returns `false` if all or part of the data was queued in user memory.
@ -1220,8 +1218,8 @@ response.writeHead(200, {
This method must only be called once on a message and it must This method must only be called once on a message and it must
be called before [`response.end()`][] is called. be called before [`response.end()`][] is called.
If you call [`response.write()`][] or [`response.end()`][] before calling this, If [`response.write()`][] or [`response.end()`][] are called before calling
the implicit/mutable headers will be calculated and call this function for you. this, the implicit/mutable headers will be calculated and call this function.
When headers have been set with [`response.setHeader()`][], they will be merged with When headers have been set with [`response.setHeader()`][], they will be merged with
any headers passed to [`response.writeHead()`][], with the headers passed to any headers passed to [`response.writeHead()`][], with the headers passed to
@ -1323,7 +1321,7 @@ header name:
added: v0.1.1 added: v0.1.1
--> -->
* {String} * {string}
In case of server request, the HTTP version sent by the client. In the case of In case of server request, the HTTP version sent by the client. In the case of
client response, the HTTP version of the connected-to server. client response, the HTTP version of the connected-to server.
@ -1337,7 +1335,7 @@ Also `message.httpVersionMajor` is the first integer and
added: v0.1.1 added: v0.1.1
--> -->
* {String} * {string}
**Only valid for request obtained from [`http.Server`][].** **Only valid for request obtained from [`http.Server`][].**
@ -1412,7 +1410,7 @@ client's authentication details.
added: v0.1.1 added: v0.1.1
--> -->
* {Number} * {number}
**Only valid for response obtained from [`http.ClientRequest`][].** **Only valid for response obtained from [`http.ClientRequest`][].**
@ -1423,7 +1421,7 @@ The 3-digit HTTP response status code. E.G. `404`.
added: v0.11.10 added: v0.11.10
--> -->
* {String} * {string}
**Only valid for response obtained from [`http.ClientRequest`][].** **Only valid for response obtained from [`http.ClientRequest`][].**
@ -1443,7 +1441,7 @@ The request/response trailers object. Only populated at the `'end'` event.
added: v0.1.90 added: v0.1.90
--> -->
* {String} * {string}
**Only valid for request obtained from [`http.Server`][].** **Only valid for request obtained from [`http.Server`][].**
@ -1462,8 +1460,8 @@ Then `request.url` will be:
'/status?name=ryan' '/status?name=ryan'
``` ```
If you would like to parse the URL into its parts, you can use To parse the url into its parts `require('url').parse(request.url)`
`require('url').parse(request.url)`. Example: can be used. Example:
```txt ```txt
$ node $ node
@ -1476,9 +1474,10 @@ $ node
} }
``` ```
If you would like to extract the parameters from the query string, To extract the parameters from the query string, the
you can use the `require('querystring').parse` function, or pass `require('querystring').parse` function can be used, or
`true` as the second argument to `require('url').parse`. Example: `true` can be passed as the second argument to `require('url').parse`.
Example:
```txt ```txt
$ node $ node
@ -1515,6 +1514,7 @@ Found'`.
<!-- YAML <!-- YAML
added: v0.1.13 added: v0.1.13
--> -->
- `requestListener` {Function}
* Returns: {http.Server} * Returns: {http.Server}
@ -1528,7 +1528,8 @@ added to the [`'request'`][] event.
added: v0.3.6 added: v0.3.6
--> -->
* `options` {Object} * `options` {Object | string} Accepts the same `options` as
[`http.request()`][], with the `method` always set to `GET`.
* `callback` {Function} * `callback` {Function}
* Returns: {http.ClientRequest} * Returns: {http.ClientRequest}
@ -1594,10 +1595,10 @@ requests.
added: v0.3.6 added: v0.3.6
--> -->
* `options` {Object} * `options` {Object | string}
* `protocol` {string} Protocol to use. Defaults to `'http:'`. * `protocol` {string} Protocol to use. Defaults to `http:`.
* `host` {string} A domain name or IP address of the server to issue the * `host` {string} A domain name or IP address of the server to issue the
request to. Defaults to `'localhost'`. request to. Defaults to `localhost`.
* `hostname` {string} Alias for `host`. To support [`url.parse()`][], * `hostname` {string} Alias for `host`. To support [`url.parse()`][],
`hostname` is preferred over `host`. `hostname` is preferred over `host`.
* `family` {number} IP address family to use when resolving `host` and * `family` {number} IP address family to use when resolving `host` and
@ -1616,7 +1617,7 @@ added: v0.3.6
* `headers` {Object} An object containing request headers. * `headers` {Object} An object containing request headers.
* `auth` {string} Basic authentication i.e. `'user:password'` to compute an * `auth` {string} Basic authentication i.e. `'user:password'` to compute an
Authorization header. Authorization header.
* `agent` {http.Agent|boolean} Controls [`Agent`][] behavior. Possible values: * `agent` {http.Agent | boolean} Controls [`Agent`][] behavior. Possible values:
* `undefined` (default): use [`http.globalAgent`][] for this host and port. * `undefined` (default): use [`http.globalAgent`][] for this host and port.
* `Agent` object: explicitly use the passed in `Agent`. * `Agent` object: explicitly use the passed in `Agent`.
* `false`: causes a new `Agent` with default values to be used. * `false`: causes a new `Agent` with default values to be used.
@ -1625,7 +1626,7 @@ added: v0.3.6
avoid creating a custom `Agent` class just to override the default avoid creating a custom `Agent` class just to override the default
`createConnection` function. See [`agent.createConnection()`][] for more `createConnection` function. See [`agent.createConnection()`][] for more
details. details.
* `timeout` {Integer}: A number specifying the socket timeout in milliseconds. * `timeout` {number}: A number specifying the socket timeout in milliseconds.
This will set the timeout before the socket is connected. This will set the timeout before the socket is connected.
* `callback` {Function} * `callback` {Function}
* Returns: {http.ClientRequest} * Returns: {http.ClientRequest}
@ -1683,7 +1684,7 @@ req.end();
``` ```
Note that in the example `req.end()` was called. With `http.request()` one Note that in the example `req.end()` was called. With `http.request()` one
must always call `req.end()` to signify that you're done with the request - must always call `req.end()` to signify the end of the request -
even if there is no data being written to the request body. even if there is no data being written to the request body.
If any error is encountered during the request (be that with DNS resolution, If any error is encountered during the request (be that with DNS resolution,
@ -1699,8 +1700,8 @@ There are a few special headers that should be noted.
* Sending a 'Content-Length' header will disable the default chunked encoding. * Sending a 'Content-Length' header will disable the default chunked encoding.
* Sending an 'Expect' header will immediately send the request headers. * Sending an 'Expect' header will immediately send the request headers.
Usually, when sending 'Expect: 100-continue', you should both set a timeout Usually, when sending 'Expect: 100-continue', both a timeout and a listener
and listen for the `'continue'` event. See RFC2616 Section 8.2.3 for more for the `continue` event should be set. See RFC2616 Section 8.2.3 for more
information. information.
* Sending an Authorization header will override using the `auth` option * Sending an Authorization header will override using the `auth` option

Write Preview
Loading…
Cancel
Save