Skip to content

Commit

Permalink
doc: new TLSSocket has no secure context options
Browse files Browse the repository at this point in the history
Unlike all the other tls APIs, if any secure context configuration is
required, the caller is responsible for creating the context.

Corrects a doc regression introduced in caa7fa9.

PR-URL: #10545
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Fedor Indutny <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
  • Loading branch information
sam-github authored and italoacasas committed Jan 27, 2017
1 parent d3628d9 commit b70dde0
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -483,12 +483,8 @@ added: v0.11.4
will be emitted on the socket before establishing a secure communication
* `secureContext`: Optional TLS context object created with
[`tls.createSecureContext()`][]. If a `secureContext` is _not_ provided, one
will be created by passing the entire `options` object to
`tls.createSecureContext()`. *Note*: In effect, all
[`tls.createSecureContext()`][] options can be provided, but they will be
_completely ignored_ unless the `secureContext` option is missing.
* ...: Optional [`tls.createSecureContext()`][] options can be provided, see
the `secureContext` option for more information.
will be created by calling [`tls.createSecureContext()`][] with no options.

Construct a new `tls.TLSSocket` object from an existing TCP socket.

### Event: 'OCSPResponse'
Expand Down

0 comments on commit b70dde0

Please sign in to comment.