diff options
| author | Sam Ruby <rubys@intertwingly.net> | 2018-07-01 11:00:24 -0400 |
|---|---|---|
| committer | Matteo Collina <hello@matteocollina.com> | 2018-07-13 14:09:39 +0100 |
| commit | f9b739ebbcb77bc5a0fc8e3d20ad2eae3285b039 (patch) | |
| tree | 71ab1360234b41cda25bb1c6e07c321589ae7dba /doc/api/https.md | |
| parent | 19bc893c7559ed53d17b9cdc372fc9614f2deda9 (diff) | |
| download | android-node-v8-f9b739ebbcb77bc5a0fc8e3d20ad2eae3285b039.tar.gz android-node-v8-f9b739ebbcb77bc5a0fc8e3d20ad2eae3285b039.tar.bz2 android-node-v8-f9b739ebbcb77bc5a0fc8e3d20ad2eae3285b039.zip | |
http: allow url and options to be passed to http*.request and http*.get
Fixes: https://github.com/nodejs/node/issues/20795
PR-URL: https://github.com/nodejs/node/pull/21616
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Ron Korving <ron@ronkorving.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc/api/https.md')
| -rw-r--r-- | doc/api/https.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/api/https.md b/doc/api/https.md index 4fdd2fe7bc..51e6e5c162 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -112,14 +112,19 @@ https.createServer(options, (req, res) => { ``` ## https.get(options[, callback]) +## https.get(url[, options][, callback]) <!-- YAML added: v0.3.6 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/21616 + description: allow both url and options to be passed to `https.get()` - version: v7.5.0 pr-url: https://github.com/nodejs/node/pull/10638 description: The `options` parameter can be a WHATWG `URL` object. --> -- `options` {Object | string | URL} Accepts the same `options` as +- `url` {string | URL} +- `options` {Object} Accepts the same `options` as [`https.request()`][], with the `method` always set to `GET`. - `callback` {Function} @@ -155,9 +160,13 @@ added: v0.5.9 Global instance of [`https.Agent`][] for all HTTPS client requests. ## https.request(options[, callback]) +## https.request(url[, options][, callback]) <!-- YAML added: v0.3.6 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/21616 + description: allow both url and options to be passed to `https.request()` - version: v9.3.0 pr-url: https://github.com/nodejs/node/pull/14903 description: The `options` parameter can now include `clientCertEngine`. @@ -165,7 +174,8 @@ changes: pr-url: https://github.com/nodejs/node/pull/10638 description: The `options` parameter can be a WHATWG `URL` object. --> -- `options` {Object | string | URL} Accepts all `options` from +- `url` {string | URL} +- `options` {Object} Accepts all `options` from [`http.request()`][], with some differences in default values: - `protocol` **Default:** `'https:'` - `port` **Default:** `443` |