1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add added: information for https

Browse Source 
Ref: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/7392
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Anna Henningsen 2016-06-23 21:51:12 +02:00
parent 72500f942b
commit e8356b25cd
No known key found for this signature in database
GPG Key ID: D8B9F5AEAE84E4CF
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/api/https.md
View File

@ -6,24 +6,39 @@ HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
separate module. separate module.
## Class: https.Agent ## Class: https.Agent
<!-- YAML
added: v0.4.5
-->
An Agent object for HTTPS similar to [`http.Agent`][]. See [`https.request()`][] An Agent object for HTTPS similar to [`http.Agent`][]. See [`https.request()`][]
for more information. for more information.
## Class: https.Server ## Class: https.Server
<!-- YAML
added: v0.3.4
-->
This class is a subclass of `tls.Server` and emits events same as This class is a subclass of `tls.Server` and emits events same as
[`http.Server`][]. See [`http.Server`][] for more information. [`http.Server`][]. See [`http.Server`][] for more information.
### server.setTimeout(msecs, callback) ### server.setTimeout(msecs, callback)
<!-- YAML
added: v0.11.2
-->
See [`http.Server#setTimeout()`][]. See [`http.Server#setTimeout()`][].
### server.timeout ### server.timeout
<!-- YAML
added: v0.11.2
-->
See [`http.Server#timeout`][]. See [`http.Server#timeout`][].
## https.createServer(options[, requestListener]) ## https.createServer(options[, requestListener])
<!-- YAML
added: v0.3.4
-->
Returns a new HTTPS web server object. The `options` is similar to Returns a new HTTPS web server object. The `options` is similar to
[`tls.createServer()`][]. The `requestListener` is a function which is [`tls.createServer()`][]. The `requestListener` is a function which is
@ -64,6 +79,9 @@ https.createServer(options, (req, res) => {
``` ```
### server.close([callback]) ### server.close([callback])
<!-- YAML
added: v0.1.90
-->
See [`http.close()`][] for details. See [`http.close()`][] for details.
@ -74,6 +92,9 @@ See [`http.close()`][] for details.
See [`http.listen()`][] for details. See [`http.listen()`][] for details.
## https.get(options, callback) ## https.get(options, callback)
<!-- YAML
added: v0.3.6
-->
Like [`http.get()`][] but for HTTPS. Like [`http.get()`][] but for HTTPS.
@ -99,10 +120,16 @@ https.get('https://encrypted.google.com/', (res) => {
``` ```
## https.globalAgent ## https.globalAgent
<!-- YAML
added: v0.5.9
-->
Global instance of [`https.Agent`][] for all HTTPS client requests. Global instance of [`https.Agent`][] for all HTTPS client requests.
## https.request(options, callback) ## https.request(options, callback)
<!-- YAML
added: v0.3.6
-->
Makes a request to a secure web server. Makes a request to a secure web server.