Skip to content

Commit

Permalink
doc: use consistent method symbol
Browse files Browse the repository at this point in the history
PR-URL: #42974
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
  • Loading branch information
ShogunPanda authored and juanarbol committed May 31, 2022
1 parent 6de289b commit 615ad8c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 24 deletions.
22 changes: 11 additions & 11 deletions doc/api/http2.md
Expand Up @@ -2355,9 +2355,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 @@ -2512,9 +2512,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 @@ -2640,9 +2640,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 @@ -4072,8 +4072,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 @@ -4089,6 +4087,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 @@ -4099,6 +4098,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
24 changes: 11 additions & 13 deletions doc/api/https.md
Expand Up @@ -133,7 +133,7 @@ added: v0.1.90
* `callback` {Function}
* Returns: {https.Server}

See [`server.close()`][`http.close()`] from the HTTP module for details.
See [`server.close()`][] in the `node:http` module.

### `server.headersTimeout`

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

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

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

### `server.listen()`

Expand All @@ -154,7 +154,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 @@ -164,7 +164,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 @@ -176,7 +176,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 @@ -190,7 +190,7 @@ changes:

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

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

### `server.keepAliveTimeout`

Expand All @@ -200,7 +200,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 @@ -521,12 +521,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`]: http.md#class-httpserver
[`http.close()`]: http.md#serverclosecallback
[`http.createServer()`]: http.md#httpcreateserveroptions-requestlistener
Expand All @@ -538,6 +532,10 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
[`net.Server`]: net.md#class-netserver
[`new URL()`]: url.md#new-urlinput-base
[`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

0 comments on commit 615ad8c

Please sign in to comment.