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