summaryrefslogtreecommitdiff
path: root/doc/api/https.md
diff options
context:
space:
mode:
authorAnna Henningsen <anna@addaleax.net>2016-06-23 21:51:12 +0200
committerAnna Henningsen <anna@addaleax.net>2016-06-29 04:07:25 +0200
commite8356b25cdf43079e8a6d74e02df67a49f64e471 (patch)
tree57105955935c65213f35ca39149cb84ed8d13827 /doc/api/https.md
parent72500f942b85e7fe66176b2807663aa225015e39 (diff)
downloadandroid-node-v8-e8356b25cdf43079e8a6d74e02df67a49f64e471.tar.gz
android-node-v8-e8356b25cdf43079e8a6d74e02df67a49f64e471.tar.bz2
android-node-v8-e8356b25cdf43079e8a6d74e02df67a49f64e471.zip
doc: add `added:` information for https
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>
Diffstat (limited to 'doc/api/https.md')
-rw-r--r--doc/api/https.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/api/https.md b/doc/api/https.md
index 09c4b5d2b9..e7cbc9969c 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
+<!-- YAML
+added: v0.4.5
+-->
An Agent object for HTTPS similar to [`http.Agent`][]. See [`https.request()`][]
for more information.
## Class: https.Server
+<!-- YAML
+added: v0.3.4
+-->
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)
+<!-- YAML
+added: v0.11.2
+-->
See [`http.Server#setTimeout()`][].
### server.timeout
+<!-- YAML
+added: v0.11.2
+-->
See [`http.Server#timeout`][].
## https.createServer(options[, requestListener])
+<!-- YAML
+added: v0.3.4
+-->
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])
+<!-- YAML
+added: v0.1.90
+-->
See [`http.close()`][] for details.
@@ -74,6 +92,9 @@ See [`http.close()`][] for details.
See [`http.listen()`][] for details.
## https.get(options, callback)
+<!-- YAML
+added: v0.3.6
+-->
Like [`http.get()`][] but for HTTPS.
@@ -99,10 +120,16 @@ https.get('https://encrypted.google.com/', (res) => {
```
## https.globalAgent
+<!-- YAML
+added: v0.5.9
+-->
Global instance of [`https.Agent`][] for all HTTPS client requests.
## https.request(options, callback)
+<!-- YAML
+added: v0.3.6
+-->
Makes a request to a secure web server.