Skip to content

Commit

Permalink
doc: fix http properties documented as methods
Browse files Browse the repository at this point in the history
* at 9772fb9
  [`maxHeadersCount`][maxheaderscount] and [`timeout`][timeout]
  were erroneously changed to methods
* `maxHeadersCount` was also listed to default to `1000` where
  it actually is [`2000`][default]

[maxheaderscount]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L276
[timeout]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L273
[default]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L312

PR-URL: #12039
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Ahmad Nassri authored and MylesBorins committed Mar 28, 2017
1 parent 948b99d commit af051f6
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -794,14 +794,14 @@ added: v5.7.0
A Boolean indicating whether or not the server is listening for
connections.

### server.maxHeadersCount([limit])
### server.maxHeadersCount
<!-- YAML
added: v0.7.0
-->

* `limit` {number} Defaults to 1000.
* {number} Defaults to 2000.

Limits maximum incoming headers count, equal to 1000 by default. If set to 0 -
Limits maximum incoming headers count, equal to 2000 by default. If set to 0 -
no limit will be applied.

### server.setTimeout([msecs][, callback])
Expand All @@ -825,12 +825,12 @@ to the Server's `'timeout'` event, timeouts must be handled explicitly.

Returns `server`.

### server.timeout([msecs])
### server.timeout
<!-- YAML
added: v0.9.12
-->

* `msecs` {number} Defaults to 120000 (2 minutes).
* {number} Defaults to 120000 (2 minutes).

The number of milliseconds of inactivity before a socket is presumed
to have timed out.
Expand Down

0 comments on commit af051f6

Please sign in to comment.