doc: document 'ciphers' option of tls.connect
authorRoman Reiss <me@silverwind.io>
Wed, 18 Feb 2015 16:55:11 +0000 (17:55 +0100)
committerBen Noordhuis <info@bnoordhuis.nl>
Wed, 18 Feb 2015 14:15:18 +0000 (15:15 +0100)
This option has been there for a long time, but has never been
documented. It's functionally identical to the server counterpart.

PR-URL: https://github.com/iojs/io.js/pull/845
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
doc/api/tls.markdown

index 63c9649..910ca5e 100644 (file)
@@ -301,6 +301,9 @@ Creates a new client connection to the given `port` and `host` (old API) or
     format. If this is omitted several well known "root" CAs will be used,
     like VeriSign. These are used to authorize connections.
 
+  - `ciphers`: A string describing the ciphers to use or exclude, separated by
+   `:`. Uses the same default cipher suite as `tls.createServer`.
+
   - `rejectUnauthorized`: If `true`, the server certificate is verified against
     the list of supplied CAs. An `'error'` event is emitted if verification
     fails; `err.code` contains the OpenSSL error code. Default: `true`.