diff options
author | Sam Ruby <rubys@intertwingly.net> | 2018-07-12 13:48:11 -0400 |
---|---|---|
committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-07-15 23:57:35 +0300 |
commit | 40c85ff0634913f4c61e13cbb7cacb7e2c76120f (patch) | |
tree | 242febebcaa984898e65cdcd6bd61d6f6c1e4fed /doc/api/https.md | |
parent | 1009118d27b069411016df4ca6915aac3c36a41f (diff) | |
download | android-node-v8-40c85ff0634913f4c61e13cbb7cacb7e2c76120f.tar.gz android-node-v8-40c85ff0634913f4c61e13cbb7cacb7e2c76120f.tar.bz2 android-node-v8-40c85ff0634913f4c61e13cbb7cacb7e2c76120f.zip |
doc: declare all parameter types
PR-URL: https://github.com/nodejs/node/pull/21782
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'doc/api/https.md')
-rw-r--r-- | doc/api/https.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/api/https.md b/doc/api/https.md index 51e6e5c162..70147c7790 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -27,7 +27,7 @@ This class is a subclass of `tls.Server` and emits events same as <!-- YAML added: v0.1.90 --> -- `callback` {Function} +* `callback` {Function} See [`server.close()`][`http.close()`] from the HTTP module for details. @@ -47,8 +47,8 @@ See [`http.Server#maxHeadersCount`][]. <!-- YAML added: v0.11.2 --> -- `msecs` {number} **Default:** `120000` (2 minutes) -- `callback` {Function} +* `msecs` {number} **Default:** `120000` (2 minutes) +* `callback` {Function} See [`http.Server#setTimeout()`][]. @@ -72,9 +72,9 @@ See [`http.Server#keepAliveTimeout`][]. <!-- YAML added: v0.3.4 --> -- `options` {Object} Accepts `options` from [`tls.createServer()`][], +* `options` {Object} Accepts `options` from [`tls.createServer()`][], [`tls.createSecureContext()`][] and [`http.createServer()`][]. -- `requestListener` {Function} A listener to be added to the `'request'` event. +* `requestListener` {Function} A listener to be added to the `'request'` event. Example: @@ -124,9 +124,9 @@ changes: description: The `options` parameter can be a WHATWG `URL` object. --> - `url` {string | URL} -- `options` {Object} Accepts the same `options` as +* `options` {Object | string | URL} Accepts the same `options` as [`https.request()`][], with the `method` always set to `GET`. -- `callback` {Function} +* `callback` {Function} Like [`http.get()`][] but for HTTPS. @@ -175,12 +175,12 @@ changes: description: The `options` parameter can be a WHATWG `URL` object. --> - `url` {string | URL} -- `options` {Object} Accepts all `options` from +* `options` {Object | string | URL} Accepts all `options` from [`http.request()`][], with some differences in default values: - `protocol` **Default:** `'https:'` - `port` **Default:** `443` - `agent` **Default:** `https.globalAgent` -- `callback` {Function} +* `callback` {Function} Makes a request to a secure web server. |