Skip to content

Commit b08ff33

Browse files
addaleaxMyles Borins
authored and
Myles Borins
committed
doc: add added: information for https
Ref: #6578 PR-URL: #7392 Reviewed-By: James M Snell <[email protected]>
1 parent 1d99059 commit b08ff33

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

doc/api/https.md

+27
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,39 @@ HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
66
separate module.
77

88
## Class: https.Agent
9+
<!-- YAML
10+
added: v0.4.5
11+
-->
912

1013
An Agent object for HTTPS similar to [`http.Agent`][]. See [`https.request()`][]
1114
for more information.
1215

1316
## Class: https.Server
17+
<!-- YAML
18+
added: v0.3.4
19+
-->
1420

1521
This class is a subclass of `tls.Server` and emits events same as
1622
[`http.Server`][]. See [`http.Server`][] for more information.
1723

1824
### server.setTimeout(msecs, callback)
25+
<!-- YAML
26+
added: v0.11.2
27+
-->
1928

2029
See [`http.Server#setTimeout()`][].
2130

2231
### server.timeout
32+
<!-- YAML
33+
added: v0.11.2
34+
-->
2335

2436
See [`http.Server#timeout`][].
2537

2638
## https.createServer(options[, requestListener])
39+
<!-- YAML
40+
added: v0.3.4
41+
-->
2742

2843
Returns a new HTTPS web server object. The `options` is similar to
2944
[`tls.createServer()`][]. The `requestListener` is a function which is
@@ -64,6 +79,9 @@ https.createServer(options, (req, res) => {
6479
```
6580

6681
### server.close([callback])
82+
<!-- YAML
83+
added: v0.1.90
84+
-->
6785

6886
See [`http.close()`][] for details.
6987

@@ -74,6 +92,9 @@ See [`http.close()`][] for details.
7492
See [`http.listen()`][] for details.
7593

7694
## https.get(options, callback)
95+
<!-- YAML
96+
added: v0.3.6
97+
-->
7798

7899
Like [`http.get()`][] but for HTTPS.
79100

@@ -99,10 +120,16 @@ https.get('https://encrypted.google.com/', (res) => {
99120
```
100121

101122
## https.globalAgent
123+
<!-- YAML
124+
added: v0.5.9
125+
-->
102126

103127
Global instance of [`https.Agent`][] for all HTTPS client requests.
104128

105129
## https.request(options, callback)
130+
<!-- YAML
131+
added: v0.3.6
132+
-->
106133

107134
Makes a request to a secure web server.
108135

0 commit comments

Comments
 (0)