summaryrefslogtreecommitdiff
path: root/doc/api/https.md
diff options
context:
space:
mode:
authorJeff Principe <princjef@gmail.com>2017-10-16 21:23:29 -0700
committerRuben Bridgewater <ruben@bridgewater.de>2018-02-10 14:15:57 +0100
commit6007a9cc0e361d428123e4c0f74024c6cd7815f4 (patch)
tree8aa2dd25795baa2d503cc89d9045ecdf7878a415 /doc/api/https.md
parentb8f47b27571f8d763f811f017be3fb37d466c4fc (diff)
downloadandroid-node-v8-6007a9cc0e361d428123e4c0f74024c6cd7815f4.tar.gz
android-node-v8-6007a9cc0e361d428123e4c0f74024c6cd7815f4.tar.bz2
android-node-v8-6007a9cc0e361d428123e4c0f74024c6cd7815f4.zip
https: add extra options to Agent#getName()
Adds the remaining options from tls.createSecureContext() to the string generated by Agent#getName(). This allows https.request() to accept the options and generate unique sockets appropriately. PR-URL: https://github.com/nodejs/node/pull/16402 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/https.md')
-rw-r--r--doc/api/https.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/api/https.md b/doc/api/https.md
index 2cc7502012..58e62ccced 100644
--- a/doc/api/https.md
+++ b/doc/api/https.md
@@ -12,7 +12,7 @@ separate module.
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.
## Class: https.Server
@@ -168,9 +168,10 @@ changes:
Makes a request to a secure web server.
-The following additional `options` from [`tls.connect()`][] are also accepted
-when using a custom [`Agent`][]: `ca`, `cert`, `ciphers`, `clientCertEngine`,
-`key`, `passphrase`, `pfx`, `rejectUnauthorized`, `secureProtocol`, `servername`
+The following additional `options` from [`tls.connect()`][] are also accepted:
+`ca`, `cert`, `ciphers`, `clientCertEngine`, `crl`, `dhparam`, `ecdhCurve`,
+`honorCipherOrder`, `key`, `passphrase`, `pfx`, `rejectUnauthorized`,
+`secureOptions`, `secureProtocol`, `servername`, `sessionIdContext`
`options` can be an object, a string, or a [`URL`][] object. If `options` is a
string, it is automatically parsed with [`url.parse()`][]. If it is a [`URL`][]
@@ -220,7 +221,7 @@ const req = https.request(options, (res) => {
});
```
-Alternatively, opt out of connection pooling by not using an `Agent`.
+Alternatively, opt out of connection pooling by not using an [`Agent`][].
Example: