Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 6e45e32

Browse files
TrottMylesBorins
authored andcommittedJan 8, 2020
doc,https: use code markup/markdown in headers
Backport-PR-URL: #31108 PR-URL: #31086 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 7d9cce6 commit 6e45e32

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed
 

‎doc/api/https.md

+16-16
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-
## Class: https.Server
48+
## Class: `https.Server`
4949
<!-- YAML
5050
added: v0.3.4
5151
-->
@@ -54,7 +54,7 @@ added: v0.3.4
5454

5555
See [`http.Server`][] for more information.
5656

57-
### server.close(\[callback\])
57+
### `server.close([callback])`
5858
<!-- YAML
5959
added: v0.1.90
6060
-->
@@ -64,7 +64,7 @@ added: v0.1.90
6464

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

67-
### server.headersTimeout
67+
### `server.headersTimeout`
6868
<!-- YAML
6969
added: v11.3.0
7070
-->
@@ -73,18 +73,18 @@ added: v11.3.0
7373

7474
See [`http.Server#headersTimeout`][].
7575

76-
### server.listen()
76+
### `server.listen()`
7777

7878
Starts the HTTPS server listening for encrypted connections.
7979
This method is identical to [`server.listen()`][] from [`net.Server`][].
8080

81-
### server.maxHeadersCount
81+
### `server.maxHeadersCount`
8282

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

8585
See [`http.Server#maxHeadersCount`][].
8686

87-
### server.setTimeout(\[msecs\]\[, callback\])
87+
### `server.setTimeout([msecs][, callback])`
8888
<!-- YAML
8989
added: v0.11.2
9090
-->
@@ -95,7 +95,7 @@ added: v0.11.2
9595

9696
See [`http.Server#setTimeout()`][].
9797

98-
### server.timeout
98+
### `server.timeout`
9999
<!-- YAML
100100
added: v0.11.2
101101
-->
@@ -104,7 +104,7 @@ added: v0.11.2
104104

105105
See [`http.Server#timeout`][].
106106

107-
### server.keepAliveTimeout
107+
### `server.keepAliveTimeout`
108108
<!-- YAML
109109
added: v8.0.0
110110
-->
@@ -113,7 +113,7 @@ added: v8.0.0
113113

114114
See [`http.Server#keepAliveTimeout`][].
115115

116-
## https.createServer(\[options\]\[, requestListener\])
116+
## `https.createServer([options][, requestListener])`
117117
<!-- YAML
118118
added: v0.3.4
119119
-->
@@ -156,8 +156,8 @@ https.createServer(options, (req, res) => {
156156
}).listen(8000);
157157
```
158158

159-
## https.get(options\[, callback\])
160-
## https.get(url\[, options\]\[, callback\])
159+
## `https.get(options[, callback])`
160+
## `https.get(url[, options][, callback])`
161161
<!-- YAML
162162
added: v0.3.6
163163
changes:
@@ -197,15 +197,15 @@ https.get('https://encrypted.google.com/', (res) => {
197197
});
198198
```
199199

200-
## https.globalAgent
200+
## `https.globalAgent`
201201
<!-- YAML
202202
added: v0.5.9
203203
-->
204204

205205
Global instance of [`https.Agent`][] for all HTTPS client requests.
206206

207-
## https.request(options\[, callback\])
208-
## https.request(url\[, options\]\[, callback\])
207+
## `https.request(options[, callback])`
208+
## `https.request(url[, options][, callback])`
209209
<!-- YAML
210210
added: v0.3.6
211211
changes:

0 commit comments

Comments
 (0)
Please sign in to comment.