FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: use consistent method symbol · nodejs/node@615ad8c · GitHub

/ node Public

Commit 615ad8c

Browse files
ShogunPanda
authored and
juanarbol
committed
doc: use consistent method symbol
PR-URL: #42974 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
1 parent 6de289b commit 615ad8c

2 files changed

Lines changed: 22 additions & 24 deletions

File tree

‎doc/api/http2.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2355,9 +2355,9 @@ changes:
23552355
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
23562356
counted towards the current limit. **Default:** `10`.
23572357
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2358-
This is similar to [`http.Server#maxHeadersCount`][] or
2359-
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2360-
**Default:** `128`.
2358+
This is similar to [`server.maxHeadersCount`][] or
2359+
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
2360+
is `4`. **Default:** `128`.
23612361
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
23622362
unacknowledged pings. **Default:** `10`.
23632363
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2512,9 +2512,9 @@ changes:
25122512
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
25132513
counted towards the current limit. **Default:** `10`.
25142514
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2515-
This is similar to [`http.Server#maxHeadersCount`][] or
2516-
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2517-
**Default:** `128`.
2515+
This is similar to [`server.maxHeadersCount`][] or
2516+
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
2517+
is `4`. **Default:** `128`.
25182518
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
25192519
unacknowledged pings. **Default:** `10`.
25202520
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2640,9 +2640,9 @@ changes:
26402640
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
26412641
counted towards the current limit. **Default:** `10`.
26422642
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2643-
This is similar to [`http.Server#maxHeadersCount`][] or
2644-
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `1`.
2645-
**Default:** `128`.
2643+
This is similar to [`server.maxHeadersCount`][] or
2644+
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
2645+
is `1`. **Default:** `128`.
26462646
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
26472647
unacknowledged pings. **Default:** `10`.
26482648
* `maxReservedRemoteStreams` {number} Sets the maximum number of reserved push
@@ -4072,8 +4072,6 @@ you need to implement any fall-back behavior yourself.
40724072
[`Http2Stream`]: #class-http2stream
40734073
[`ServerHttp2Stream`]: #class-serverhttp2stream
40744074
[`TypeError`]: errors.md#class-typeerror
4075-
[`http.ClientRequest#maxHeadersCount`]: http.md#requestmaxheaderscount
4076-
[`http.Server#maxHeadersCount`]: http.md#servermaxheaderscount
40774075
[`http2.SecureServer`]: #class-http2secureserver
40784076
[`http2.Server`]: #class-http2server
40794077
[`http2.createSecureServer()`]: #http2createsecureserveroptions-onrequesthandler
@@ -4089,6 +4087,7 @@ you need to implement any fall-back behavior yourself.
40894087
[`net.connect()`]: net.md#netconnect
40904088
[`net.createServer()`]: net.md#netcreateserveroptions-connectionlistener
40914089
[`request.authority`]: #requestauthority
4090+
[`request.maxHeadersCount`]: http.md#requestmaxheaderscount
40924091
[`request.socket.getPeerCertificate()`]: tls.md#tlssocketgetpeercertificatedetailed
40934092
[`request.socket`]: #requestsocket
40944093
[`response.end()`]: #responseenddata-encoding-callback
@@ -4099,6 +4098,7 @@ you need to implement any fall-back behavior yourself.
40994098
[`response.write(data, encoding)`]: http.md#responsewritechunk-encoding-callback
41004099
[`response.writeContinue()`]: #responsewritecontinue
41014100
[`response.writeHead()`]: #responsewriteheadstatuscode-statusmessage-headers
4101+
[`server.maxHeadersCount`]: http.md#servermaxheaderscount
41024102
[`tls.Server.close()`]: tls.md#serverclosecallback
41034103
[`tls.TLSSocket`]: tls.md#class-tlstlssocket
41044104
[`tls.connect()`]: tls.md#tlsconnectoptions-callback

‎doc/api/https.md‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ added: v0.1.90
133133
* `callback` {Function}
134134
* Returns: {https.Server}
135135

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

138138
### `server.headersTimeout`
139139

@@ -143,7 +143,7 @@ added: v11.3.0
143143

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

146-
See [`http.Server#headersTimeout`][].
146+
See [`server.headersTimeout`][] in the `node:http` module.
147147

148148
### `server.listen()`
149149

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

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

157-
See [`http.Server#maxHeadersCount`][].
157+
See [`server.maxHeadersCount`][] in the `node:http` module.
158158

159159
### `server.requestTimeout`
160160

@@ -164,7 +164,7 @@ added: v14.11.0
164164

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

167-
See [`http.Server#requestTimeout`][].
167+
See [`server.requestTimeout`][] in the `node:http` module.
168168

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

@@ -176,7 +176,7 @@ added: v0.11.2
176176
* `callback` {Function}
177177
* Returns: {https.Server}
178178

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

181181
### `server.timeout`
182182

@@ -190,7 +190,7 @@ changes:
190190

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

193-
See [`http.Server#timeout`][].
193+
See [`server.timeout`][] in the `node:http` module.
194194

195195
### `server.keepAliveTimeout`
196196

@@ -200,7 +200,7 @@ added: v8.0.0
200200

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

203-
See [`http.Server#keepAliveTimeout`][].
203+
See [`server.keepAliveTimeout`][] in the `node:http` module.
204204

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

@@ -521,12 +521,6 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
521521
[`http.Agent(options)`]: http.md#new-agentoptions
522522
[`http.Agent`]: http.md#class-httpagent
523523
[`http.ClientRequest`]: http.md#class-httpclientrequest
524-
[`http.Server#headersTimeout`]: http.md#serverheaderstimeout
525-
[`http.Server#keepAliveTimeout`]: http.md#serverkeepalivetimeout
526-
[`http.Server#maxHeadersCount`]: http.md#servermaxheaderscount
527-
[`http.Server#requestTimeout`]: http.md#serverrequesttimeout
528-
[`http.Server#setTimeout()`]: http.md#serversettimeoutmsecs-callback
529-
[`http.Server#timeout`]: http.md#servertimeout
530524
[`http.Server`]: http.md#class-httpserver
531525
[`http.close()`]: http.md#serverclosecallback
532526
[`http.createServer()`]: http.md#httpcreateserveroptions-requestlistener
@@ -538,6 +532,10 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
538532
[`net.Server`]: net.md#class-netserver
539533
[`new URL()`]: url.md#new-urlinput-base
540534
[`server.listen()`]: net.md#serverlisten
535+
[`server.maxHeadersCount`]: http.md#servermaxheaderscount
536+
[`server.requestTimeout`]: http.md#serverrequesttimeout
537+
[`server.setTimeout()`]: http.md#serversettimeoutmsecs-callback
538+
[`server.timeout`]: http.md#servertimeout
541539
[`tls.connect()`]: tls.md#tlsconnectoptions-callback
542540
[`tls.createSecureContext()`]: tls.md#tlscreatesecurecontextoptions
543541
[`tls.createServer()`]: tls.md#tlscreateserveroptions-secureconnectionlistener

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL