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

doc: use consistent method symbol #42974

Merged
merged 4 commits into from
May 10, 2022
Merged
Show file tree
Hide file tree
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
22 changes: 11 additions & 11 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2410,9 +2410,9 @@ changes:
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
counted towards the current limit. **Default:** `10`.
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
This is similar to [`http.Server#maxHeadersCount`][] or
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
**Default:** `128`.
This is similar to [`server.maxHeadersCount`][] or
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
is `4`. **Default:** `128`.
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
unacknowledged pings. **Default:** `10`.
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
Expand Down Expand Up @@ -2567,9 +2567,9 @@ changes:
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
counted towards the current limit. **Default:** `10`.
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
This is similar to [`http.Server#maxHeadersCount`][] or
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
**Default:** `128`.
This is similar to [`server.maxHeadersCount`][] or
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
is `4`. **Default:** `128`.
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
unacknowledged pings. **Default:** `10`.
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
Expand Down Expand Up @@ -2695,9 +2695,9 @@ changes:
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
counted towards the current limit. **Default:** `10`.
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
This is similar to [`http.Server#maxHeadersCount`][] or
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `1`.
**Default:** `128`.
This is similar to [`server.maxHeadersCount`][] or
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
is `1`. **Default:** `128`.
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
unacknowledged pings. **Default:** `10`.
* `maxReservedRemoteStreams` {number} Sets the maximum number of reserved push
Expand Down Expand Up @@ -4135,8 +4135,6 @@ you need to implement any fall-back behavior yourself.
[`Http2Stream`]: #class-http2stream
[`ServerHttp2Stream`]: #class-serverhttp2stream
[`TypeError`]: errors.md#class-typeerror
[`http.ClientRequest#maxHeadersCount`]: http.md#requestmaxheaderscount
[`http.Server#maxHeadersCount`]: http.md#servermaxheaderscount
[`http2.SecureServer`]: #class-http2secureserver
[`http2.Server`]: #class-http2server
[`http2.createSecureServer()`]: #http2createsecureserveroptions-onrequesthandler
Expand All @@ -4152,6 +4150,7 @@ you need to implement any fall-back behavior yourself.
[`net.connect()`]: net.md#netconnect
[`net.createServer()`]: net.md#netcreateserveroptions-connectionlistener
[`request.authority`]: #requestauthority
[`request.maxHeadersCount`]: http.md#requestmaxheaderscount
[`request.socket.getPeerCertificate()`]: tls.md#tlssocketgetpeercertificatedetailed
[`request.socket`]: #requestsocket
[`response.end()`]: #responseenddata-encoding-callback
Expand All @@ -4162,6 +4161,7 @@ you need to implement any fall-back behavior yourself.
[`response.write(data, encoding)`]: http.md#responsewritechunk-encoding-callback
[`response.writeContinue()`]: #responsewritecontinue
[`response.writeHead()`]: #responsewriteheadstatuscode-statusmessage-headers
[`server.maxHeadersCount`]: http.md#servermaxheaderscount
[`tls.Server.close()`]: tls.md#serverclosecallback
[`tls.TLSSocket`]: tls.md#class-tlstlssocket
[`tls.connect()`]: tls.md#tlsconnectoptions-callback
Expand Down
36 changes: 18 additions & 18 deletions doc/api/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,23 +133,23 @@ added: v0.1.90
* `callback` {Function}
* Returns: {https.Server}

See [`http.Server.close()`][].
See [`server.close()`][] in the `node:http` module.

### `server.closeAllConnections()`

<!-- YAML
added: REPLACEME
-->

See [`http.Server.closeAllConnections()`][].
See [`server.closeAllConnections()`][] in the `node:http` module.

### `server.closeIdleConnections()`

<!-- YAML
added: REPLACEME
-->

See [`http.Server.closeIdleConnections()`][].
See [`server.closeIdleConnections()`][] in the `node:http` module.

### `server.headersTimeout`

Expand All @@ -159,7 +159,7 @@ added: v11.3.0

* {number} **Default:** `60000`

See [`http.Server#headersTimeout`][].
See [`server.headersTimeout`][] in the `node:http` module.

### `server.listen()`

Expand All @@ -170,7 +170,7 @@ This method is identical to [`server.listen()`][] from [`net.Server`][].

* {number} **Default:** `2000`

See [`http.Server#maxHeadersCount`][].
See [`server.maxHeadersCount`][] in the `node:http` module.

### `server.requestTimeout`

Expand All @@ -180,7 +180,7 @@ added: v14.11.0

* {number} **Default:** `0`

See [`http.Server#requestTimeout`][].
See [`server.requestTimeout`][] in the `node:http` module.

### `server.setTimeout([msecs][, callback])`

Expand All @@ -192,7 +192,7 @@ added: v0.11.2
* `callback` {Function}
* Returns: {https.Server}

See [`http.Server#setTimeout()`][].
See [`server.setTimeout()`][] in the `node:http` module.

### `server.timeout`

Expand All @@ -206,7 +206,7 @@ changes:

* {number} **Default:** 0 (no timeout)

See [`http.Server#timeout`][].
See [`server.timeout`][] in the `node:http` module.

### `server.keepAliveTimeout`

Expand All @@ -216,7 +216,7 @@ added: v8.0.0

* {number} **Default:** `5000` (5 seconds)

See [`http.Server#keepAliveTimeout`][].
See [`server.keepAliveTimeout`][] in the `node:http` module.

## `https.createServer([options][, requestListener])`

Expand Down Expand Up @@ -539,15 +539,6 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
[`http.Agent(options)`]: http.md#new-agentoptions
[`http.Agent`]: http.md#class-httpagent
[`http.ClientRequest`]: http.md#class-httpclientrequest
[`http.Server#headersTimeout`]: http.md#serverheaderstimeout
[`http.Server#keepAliveTimeout`]: http.md#serverkeepalivetimeout
[`http.Server#maxHeadersCount`]: http.md#servermaxheaderscount
[`http.Server#requestTimeout`]: http.md#serverrequesttimeout
[`http.Server#setTimeout()`]: http.md#serversettimeoutmsecs-callback
[`http.Server#timeout`]: http.md#servertimeout
[`http.Server.close()`]: http.md#serverclosecallback
[`http.Server.closeAllConnections()`]: http.md#servercloseallconnections
[`http.Server.closeIdleConnections()`]: http.md#servercloseidleconnections
[`http.Server`]: http.md#class-httpserver
[`http.createServer()`]: http.md#httpcreateserveroptions-requestlistener
[`http.get()`]: http.md#httpgetoptions-callback
Expand All @@ -557,7 +548,16 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
[`import()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#dynamic_imports
[`net.Server`]: net.md#class-netserver
[`new URL()`]: url.md#new-urlinput-base
[`server.close()`]: http.md#serverclosecallback
[`server.closeAllConnections()`]: http.md#servercloseallconnections
[`server.closeIdleConnections()`]: http.md#servercloseidleconnections
[`server.headersTimeout`]: http.md#serverheaderstimeout
[`server.keepAliveTimeout`]: http.md#serverkeepalivetimeout
[`server.listen()`]: net.md#serverlisten
[`server.maxHeadersCount`]: http.md#servermaxheaderscount
[`server.requestTimeout`]: http.md#serverrequesttimeout
[`server.setTimeout()`]: http.md#serversettimeoutmsecs-callback
[`server.timeout`]: http.md#servertimeout
[`tls.connect()`]: tls.md#tlsconnectoptions-callback
[`tls.createSecureContext()`]: tls.md#tlscreatesecurecontextoptions
[`tls.createServer()`]: tls.md#tlscreateserveroptions-secureconnectionlistener
Expand Down