Skip to content
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.

Sign up for GitHub

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

doc: use serial comma in tls docs #43001

Merged
merged 1 commit into from
May 8, 2022
Merged

doc: use serial comma in tls docs #43001

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/api/tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1606,7 +1606,7 @@ changes:
* `socket` {stream.Duplex} Establish secure connection on a given socket
rather than creating a new socket. Typically, this is an instance of
[`net.Socket`][], but any `Duplex` stream is allowed.
If this option is specified, `path`, `host` and `port` are ignored,
If this option is specified, `path`, `host`, and `port` are ignored,
except for certificate validation. Usually, a socket is already connected
when passed to `tls.connect()`, but it can be connected later.
Connection/disconnection/destruction of `socket` is the user's
Expand Down Expand Up @@ -1641,8 +1641,8 @@ changes:
More information can be found in the [RFC 4279][].
* `ALPNProtocols`: {string\[]|Buffer\[]|TypedArray\[]|DataView\[]|Buffer|
TypedArray|DataView}
An array of strings, `Buffer`s or `TypedArray`s or `DataView`s, or a
single `Buffer` or `TypedArray` or `DataView` containing the supported ALPN
An array of strings, `Buffer`s, `TypedArray`s, or `DataView`s, or a
single `Buffer`, `TypedArray`, or `DataView` containing the supported ALPN
Comment on lines +1644 to +1645
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't have to be in this PR, but it's probably worth finding another way to express this, or maybe removing the list of possible types entirely as the types are described immediately above.

protocols. `Buffer`s should have the format `[len][name][len][name]...`
e.g. `'\x08http/1.1\x08http/1.0'`, where the `len` byte is the length of the
next protocol name. Passing an array is usually much simpler, e.g.
Expand Down Expand Up @@ -2028,8 +2028,8 @@ changes:
* `options` {Object}
* `ALPNProtocols`: {string\[]|Buffer\[]|TypedArray\[]|DataView\[]|Buffer|
TypedArray|DataView}
An array of strings, `Buffer`s or `TypedArray`s or `DataView`s, or a single
`Buffer` or `TypedArray` or `DataView` containing the supported ALPN
An array of strings, `Buffer`s, `TypedArray`s, or `DataView`s, or a single
`Buffer`, `TypedArray`, or `DataView` containing the supported ALPN
protocols. `Buffer`s should have the format `[len][name][len][name]...`
e.g. `0x05hello0x05world`, where the first byte is the length of the next
protocol name. Passing an array is usually much simpler, e.g.
Expand Down Expand Up @@ -2088,7 +2088,7 @@ changes:
in TLS 1.3. Upon failing to set pskIdentityHint `'tlsClientError'` will be
emitted with `'ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED'` code.
* ...: Any [`tls.createSecureContext()`][] option can be provided. For
servers, the identity options (`pfx`, `key`/`cert` or `pskCallback`)
servers, the identity options (`pfx`, `key`/`cert`, or `pskCallback`)
are usually required.
* ...: Any [`net.createServer()`][] option can be provided.
* `secureConnectionListener` {Function}
Expand Down