Skip to content

Commit 3571df3

Browse files
TrottBridgeAR
authored andcommitted
doc,https: use code markup/markdown in headers
PR-URL: #31086 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 3062bcb commit 3571df3

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

doc/api/https.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
88
separate module.
99

10-
## Class: https.Agent
10+
## Class: `https.Agent`
1111
<!-- YAML
1212
added: v0.4.5
1313
changes:
@@ -23,7 +23,7 @@ changes:
2323
An [`Agent`][] object for HTTPS similar to [`http.Agent`][]. See
2424
[`https.request()`][] for more information.
2525

26-
### new Agent(\[options\])
26+
### `new Agent([options])`
2727
<!-- YAML
2828
changes:
2929
- version: v12.5.0
@@ -45,7 +45,7 @@ changes:
4545

4646
See [`Session Resumption`][] for information about TLS session reuse.
4747

48-
#### Event: 'keylog'
48+
#### Event: `'keylog'`
4949
<!-- YAML
5050
added: v13.2.0
5151
-->
@@ -70,7 +70,7 @@ https.globalAgent.on('keylog', (line, tlsSocket) => {
7070
});
7171
```
7272

73-
## Class: https.Server
73+
## Class: `https.Server`
7474
<!-- YAML
7575
added: v0.3.4
7676
-->
@@ -79,7 +79,7 @@ added: v0.3.4
7979

8080
See [`http.Server`][] for more information.
8181

82-
### server.close(\[callback\])
82+
### `server.close([callback])`
8383
<!-- YAML
8484
added: v0.1.90
8585
-->
@@ -89,7 +89,7 @@ added: v0.1.90
8989

9090
See [`server.close()`][`http.close()`] from the HTTP module for details.
9191

92-
### server.headersTimeout
92+
### `server.headersTimeout`
9393
<!-- YAML
9494
added: v11.3.0
9595
-->
@@ -98,18 +98,18 @@ added: v11.3.0
9898

9999
See [`http.Server#headersTimeout`][].
100100

101-
### server.listen()
101+
### `server.listen()`
102102

103103
Starts the HTTPS server listening for encrypted connections.
104104
This method is identical to [`server.listen()`][] from [`net.Server`][].
105105

106-
### server.maxHeadersCount
106+
### `server.maxHeadersCount`
107107

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

110110
See [`http.Server#maxHeadersCount`][].
111111

112-
### server.setTimeout(\[msecs\]\[, callback\])
112+
### `server.setTimeout([msecs][, callback])`
113113
<!-- YAML
114114
added: v0.11.2
115115
-->
@@ -120,7 +120,7 @@ added: v0.11.2
120120

121121
See [`http.Server#setTimeout()`][].
122122

123-
### server.timeout
123+
### `server.timeout`
124124
<!-- YAML
125125
added: v0.11.2
126126
-->
@@ -129,7 +129,7 @@ added: v0.11.2
129129

130130
See [`http.Server#timeout`][].
131131

132-
### server.keepAliveTimeout
132+
### `server.keepAliveTimeout`
133133
<!-- YAML
134134
added: v8.0.0
135135
-->
@@ -138,7 +138,7 @@ added: v8.0.0
138138

139139
See [`http.Server#keepAliveTimeout`][].
140140

141-
## https.createServer(\[options\]\[, requestListener\])
141+
## `https.createServer([options][, requestListener])`
142142
<!-- YAML
143143
added: v0.3.4
144144
-->
@@ -181,8 +181,8 @@ https.createServer(options, (req, res) => {
181181
}).listen(8000);
182182
```
183183

184-
## https.get(options\[, callback\])
185-
## https.get(url\[, options\]\[, callback\])
184+
## `https.get(options[, callback])`
185+
## `https.get(url[, options][, callback])`
186186
<!-- YAML
187187
added: v0.3.6
188188
changes:
@@ -222,15 +222,15 @@ https.get('https://encrypted.google.com/', (res) => {
222222
});
223223
```
224224

225-
## https.globalAgent
225+
## `https.globalAgent`
226226
<!-- YAML
227227
added: v0.5.9
228228
-->
229229

230230
Global instance of [`https.Agent`][] for all HTTPS client requests.
231231

232-
## https.request(options\[, callback\])
233-
## https.request(url\[, options\]\[, callback\])
232+
## `https.request(options[, callback])`
233+
## `https.request(url[, options][, callback])`
234234
<!-- YAML
235235
added: v0.3.6
236236
changes:

0 commit comments

Comments
 (0)