Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 31e39fb

Browse filesBrowse files
svozzarvagg
authored andcommitted
doc: remove non-standard use of hyphens
Identifies the non-idiomatic usages of the '-' character and either removes them or replaces them with colons. Fixes: #5672 R-URL: #5677 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
1 parent f225459 commit 31e39fb
Copy full SHA for 31e39fb

File tree

Expand file treeCollapse file tree

1 file changed

+13
-13
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+13
-13
lines changed
Open diff view settings
Collapse file

‎doc/api/tls.markdown‎

Copy file name to clipboardExpand all lines: doc/api/tls.markdown
+13-13Lines changed: 13 additions & 13 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ openssl pkcs12 -export -in agent5-cert.pem -inkey agent5-key.pem \
5656

5757
ALPN (Application-Layer Protocol Negotiation Extension), NPN (Next
5858
Protocol Negotiation) and SNI (Server Name Indication) are TLS
59-
handshake extensions allowing you:
59+
handshake extensions:
6060

61-
* ALPN/NPN - to use one TLS server for multiple protocols (HTTP, SPDY, HTTP/2)
62-
* SNI - to use one TLS server for multiple hostnames with different SSL
61+
* ALPN/NPN - Allows the use of one TLS server for multiple protocols (HTTP, SPDY, HTTP/2)
62+
* SNI - Allows the use of one TLS server for multiple hostnames with different SSL
6363
certificates.
6464

6565
## Client-initiated renegotiation attack mitigation
@@ -187,8 +187,8 @@ connections using TLS or SSL.
187187

188188
`function (exception, tlsSocket) { }`
189189

190-
When a client connection emits an `'error'` event before secure connection is
191-
established - it will be forwarded here.
190+
When a client connection emits an `'error'` event before a secure connection is
191+
established it will be forwarded here.
192192

193193
`tlsSocket` is the [`tls.TLSSocket`][] that the error originated from.
194194

@@ -370,7 +370,7 @@ Construct a new TLSSocket object from existing TCP socket.
370370
- `secureContext`: An optional TLS context object from
371371
[`tls.createSecureContext()`][]
372372

373-
- `isServer`: If `true` - TLS socket will be instantiated in server-mode.
373+
- `isServer`: If `true` the TLS socket will be instantiated in server-mode.
374374
Default: `false`
375375

376376
- `server`: An optional [`net.Server`][] instance
@@ -387,9 +387,9 @@ Construct a new TLSSocket object from existing TCP socket.
387387

388388
- `session`: Optional, a `Buffer` instance, containing TLS session
389389

390-
- `requestOCSP`: Optional, if `true` - OCSP status request extension would
391-
be added to client hello, and `'OCSPResponse'` event will be emitted on socket
392-
before establishing secure communication
390+
- `requestOCSP`: Optional, if `true` the OCSP status request extension will
391+
be added to the client hello, and an `'OCSPResponse'` event will be emitted
392+
on the socket before establishing a secure communication
393393

394394
### Event: 'OCSPResponse'
395395

@@ -408,7 +408,7 @@ The listener will be called no matter if the server's certificate was
408408
authorized or not. It is up to the user to test `tlsSocket.authorized`
409409
to see if the server certificate was signed by one of the specified CAs.
410410
If `tlsSocket.authorized === false` then the error can be found in
411-
`tlsSocket.authorizationError`. Also if ALPN or NPN was used - you can
411+
`tlsSocket.authorizationError`. Also, if ALPN or NPN was used you can
412412
check `tlsSocket.alpnProtocol` or `tlsSocket.npnProtocol` for the
413413
negotiated protocol.
414414

@@ -463,8 +463,8 @@ Example:
463463

464464
Returns an object representing the peer's certificate. The returned object has
465465
some properties corresponding to the field of the certificate. If `detailed`
466-
argument is `true` - the full chain with `issuer` property will be returned,
467-
if `false` - only the top certificate without `issuer` property.
466+
argument is `true` the full chain with `issuer` property will be returned,
467+
if `false` only the top certificate without `issuer` property.
468468

469469
Example:
470470

@@ -876,7 +876,7 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
876876
and `cb`. `SNICallback` should invoke `cb(null, ctx)`, where `ctx` is a
877877
SecureContext instance.
878878
(You can use `tls.createSecureContext(...)` to get proper
879-
SecureContext). If `SNICallback` wasn't provided - default callback with
879+
SecureContext). If `SNICallback` wasn't provided the default callback with
880880
high-level API will be used (see below).
881881

882882
- `sessionTimeout`: An integer specifying the seconds after which TLS

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.