Skip to content

Commit 0957212

Browse files
ShogunPandaBethGriggs
authored andcommitted
doc: use consistent method symbol
PR-URL: #42974 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]>
1 parent e9e1f1e commit 0957212

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

doc/api/http2.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -2410,9 +2410,9 @@ changes:
24102410
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
24112411
counted towards the current limit. **Default:** `10`.
24122412
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2413-
This is similar to [`http.Server#maxHeadersCount`][] or
2414-
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2415-
**Default:** `128`.
2413+
This is similar to [`server.maxHeadersCount`][] or
2414+
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
2415+
is `4`. **Default:** `128`.
24162416
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
24172417
unacknowledged pings. **Default:** `10`.
24182418
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2567,9 +2567,9 @@ changes:
25672567
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
25682568
counted towards the current limit. **Default:** `10`.
25692569
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2570-
This is similar to [`http.Server#maxHeadersCount`][] or
2571-
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `4`.
2572-
**Default:** `128`.
2570+
This is similar to [`server.maxHeadersCount`][] or
2571+
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
2572+
is `4`. **Default:** `128`.
25732573
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
25742574
unacknowledged pings. **Default:** `10`.
25752575
* `maxSendHeaderBlockLength` {number} Sets the maximum allowed size for a
@@ -2695,9 +2695,9 @@ changes:
26952695
queued to be sent, and unacknowledged `PING` and `SETTINGS` frames are all
26962696
counted towards the current limit. **Default:** `10`.
26972697
* `maxHeaderListPairs` {number} Sets the maximum number of header entries.
2698-
This is similar to [`http.Server#maxHeadersCount`][] or
2699-
[`http.ClientRequest#maxHeadersCount`][]. The minimum value is `1`.
2700-
**Default:** `128`.
2698+
This is similar to [`server.maxHeadersCount`][] or
2699+
[`request.maxHeadersCount`][] in the `node:http` module. The minimum value
2700+
is `1`. **Default:** `128`.
27012701
* `maxOutstandingPings` {number} Sets the maximum number of outstanding,
27022702
unacknowledged pings. **Default:** `10`.
27032703
* `maxReservedRemoteStreams` {number} Sets the maximum number of reserved push
@@ -4135,8 +4135,6 @@ you need to implement any fall-back behavior yourself.
41354135
[`Http2Stream`]: #class-http2stream
41364136
[`ServerHttp2Stream`]: #class-serverhttp2stream
41374137
[`TypeError`]: errors.md#class-typeerror
4138-
[`http.ClientRequest#maxHeadersCount`]: http.md#requestmaxheaderscount
4139-
[`http.Server#maxHeadersCount`]: http.md#servermaxheaderscount
41404138
[`http2.SecureServer`]: #class-http2secureserver
41414139
[`http2.Server`]: #class-http2server
41424140
[`http2.createSecureServer()`]: #http2createsecureserveroptions-onrequesthandler
@@ -4152,6 +4150,7 @@ you need to implement any fall-back behavior yourself.
41524150
[`net.connect()`]: net.md#netconnect
41534151
[`net.createServer()`]: net.md#netcreateserveroptions-connectionlistener
41544152
[`request.authority`]: #requestauthority
4153+
[`request.maxHeadersCount`]: http.md#requestmaxheaderscount
41554154
[`request.socket.getPeerCertificate()`]: tls.md#tlssocketgetpeercertificatedetailed
41564155
[`request.socket`]: #requestsocket
41574156
[`response.end()`]: #responseenddata-encoding-callback
@@ -4162,6 +4161,7 @@ you need to implement any fall-back behavior yourself.
41624161
[`response.write(data, encoding)`]: http.md#responsewritechunk-encoding-callback
41634162
[`response.writeContinue()`]: #responsewritecontinue
41644163
[`response.writeHead()`]: #responsewriteheadstatuscode-statusmessage-headers
4164+
[`server.maxHeadersCount`]: http.md#servermaxheaderscount
41654165
[`tls.Server.close()`]: tls.md#serverclosecallback
41664166
[`tls.TLSSocket`]: tls.md#class-tlstlssocket
41674167
[`tls.connect()`]: tls.md#tlsconnectoptions-callback

doc/api/https.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -133,23 +133,23 @@ added: v0.1.90
133133
* `callback` {Function}
134134
* Returns: {https.Server}
135135

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

138138
### `server.closeAllConnections()`
139139

140140
<!-- YAML
141141
added: REPLACEME
142142
-->
143143

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

146146
### `server.closeIdleConnections()`
147147

148148
<!-- YAML
149149
added: REPLACEME
150150
-->
151151

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

154154
### `server.headersTimeout`
155155

@@ -159,7 +159,7 @@ added: v11.3.0
159159

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

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

164164
### `server.listen()`
165165

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

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

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

175175
### `server.requestTimeout`
176176

@@ -180,7 +180,7 @@ added: v14.11.0
180180

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

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

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

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

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

197197
### `server.timeout`
198198

@@ -206,7 +206,7 @@ changes:
206206

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

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

211211
### `server.keepAliveTimeout`
212212

@@ -216,7 +216,7 @@ added: v8.0.0
216216

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

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

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

@@ -539,15 +539,6 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
539539
[`http.Agent(options)`]: http.md#new-agentoptions
540540
[`http.Agent`]: http.md#class-httpagent
541541
[`http.ClientRequest`]: http.md#class-httpclientrequest
542-
[`http.Server#headersTimeout`]: http.md#serverheaderstimeout
543-
[`http.Server#keepAliveTimeout`]: http.md#serverkeepalivetimeout
544-
[`http.Server#maxHeadersCount`]: http.md#servermaxheaderscount
545-
[`http.Server#requestTimeout`]: http.md#serverrequesttimeout
546-
[`http.Server#setTimeout()`]: http.md#serversettimeoutmsecs-callback
547-
[`http.Server#timeout`]: http.md#servertimeout
548-
[`http.Server.close()`]: http.md#serverclosecallback
549-
[`http.Server.closeAllConnections()`]: http.md#servercloseallconnections
550-
[`http.Server.closeIdleConnections()`]: http.md#servercloseidleconnections
551542
[`http.Server`]: http.md#class-httpserver
552543
[`http.createServer()`]: http.md#httpcreateserveroptions-requestlistener
553544
[`http.get()`]: http.md#httpgetoptions-callback
@@ -557,7 +548,16 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
557548
[`import()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#dynamic_imports
558549
[`net.Server`]: net.md#class-netserver
559550
[`new URL()`]: url.md#new-urlinput-base
551+
[`server.close()`]: http.md#serverclosecallback
552+
[`server.closeAllConnections()`]: http.md#servercloseallconnections
553+
[`server.closeIdleConnections()`]: http.md#servercloseidleconnections
554+
[`server.headersTimeout`]: http.md#serverheaderstimeout
555+
[`server.keepAliveTimeout`]: http.md#serverkeepalivetimeout
560556
[`server.listen()`]: net.md#serverlisten
557+
[`server.maxHeadersCount`]: http.md#servermaxheaderscount
558+
[`server.requestTimeout`]: http.md#serverrequesttimeout
559+
[`server.setTimeout()`]: http.md#serversettimeoutmsecs-callback
560+
[`server.timeout`]: http.md#servertimeout
561561
[`tls.connect()`]: tls.md#tlsconnectoptions-callback
562562
[`tls.createSecureContext()`]: tls.md#tlscreatesecurecontextoptions
563563
[`tls.createServer()`]: tls.md#tlscreateserveroptions-secureconnectionlistener

0 commit comments

Comments
 (0)