-
Notifications
You must be signed in to change notification settings - Fork 30.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fixed TLSSocket documentation error from Issue #3963. #14062
Changes from all commits
55f3170
09f8564
cbbe60c
7e766ff
8b945f8
5144cf4
fda1b66
de3d050
872132e
5c41572
955ad0f
9658ac3
077508d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -821,6 +821,28 @@ The `callback` function, if specified, will be added as a listener for the | |
|
||
`tls.connect()` returns a [`tls.TLSSocket`][] object. | ||
|
||
To upgrade an existing instance of `net.Socket` to a | ||
`tls.TLSSocket`, pass it to `tls.connect()` as | ||
the socket option: | ||
|
||
```js | ||
const { Socket } = require('net'); | ||
const tls = require('tls'); | ||
const socket = new Socket(); | ||
const secureSock = tls.connect({ socket }, () => { | ||
console.log('The TLS socket has been connected.'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. at this point, neither the underlying Socket or tls.TLSSocket are connected, so the log message is misleading (see description of the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This must have slipped through, earlier commits had the actual |
||
}); | ||
``` | ||
|
||
If no socket is provided, this function will create a new TLS socket: | ||
|
||
```js | ||
const tls = require('tls'); | ||
const secureSock = tls.connect({ port: 443, host: 'example.org' }, () => { | ||
console.log('The TLS socket has been connected.'); | ||
}); | ||
``` | ||
|
||
The following implements a simple "echo server" example: | ||
|
||
```js | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is documented above, does it really need an example? was the existing description of the
socket:
option somehow deficient?