Skip to content

Commit 82f49e3

Browse files
estliberitasMyles Borins
authored andcommitted
doc: fix links in tls, cluster docs
Fix missing links described in #5322. PR-URL: #5364 Reviewed-By: Roman Reiss <me@silverwind.io>
1 parent a80e9a6 commit 82f49e3

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

doc/api/cluster.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ Causes `.suicide` to be set.
244244
Note that after a server is closed, it will no longer accept new connections,
245245
but connections may be accepted by any other listening worker. Existing
246246
connections will be allowed to close as usual. When no more connections exist,
247-
see [server.close()][], the IPC channel to the worker will close allowing it to
247+
see [`server.close()`][], the IPC channel to the worker will close allowing it to
248248
die gracefully.
249249

250250
The above applies *only* to server connections, client connections are not

doc/api/tls.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ server-side resources, which makes it a potential vector for denial-of-service
6161
attacks.
6262

6363
To mitigate this, renegotiations are limited to three times every 10 minutes. An
64-
error is emitted on the [tls.TLSSocket][] instance when the threshold is
64+
error is emitted on the [`tls.TLSSocket`][] instance when the threshold is
6565
exceeded. The limits are configurable:
6666

6767
- `tls.CLIENT_RENEG_LIMIT`: renegotiation limit, default is 3.
@@ -159,7 +159,7 @@ is expensive.
159159

160160
## Class: CryptoStream
161161

162-
Stability: 0 - Deprecated: Use [`tls.TLSSocket()`][] instead.
162+
Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
163163

164164
This is an encrypted stream.
165165

@@ -196,7 +196,7 @@ connections using TLS or SSL.
196196
When a client connection emits an `'error'` event before secure connection is
197197
established - it will be forwarded here.
198198

199-
`tlsSocket` is the [tls.TLSSocket][] that the error originated from.
199+
`tlsSocket` is the [`tls.TLSSocket`][] that the error originated from.
200200

201201
### Event: 'newSession'
202202

@@ -278,7 +278,7 @@ server.on('resumeSession', (id, cb) => {
278278
`function (tlsSocket) {}`
279279

280280
This event is emitted after a new connection has been successfully
281-
handshaked. The argument is an instance of [tls.TLSSocket][]. It has all the
281+
handshaked. The argument is an instance of [`tls.TLSSocket`][]. It has all the
282282
common stream methods and events.
283283

284284
`socket.authorized` is a boolean value which indicates if the
@@ -596,7 +596,7 @@ Creates a new client connection to the given `port` and `host` (old API) or
596596
The `callback` parameter will be added as a listener for the
597597
[`'secureConnect'`][] event.
598598

599-
`tls.connect()` returns a [tls.TLSSocket][] object.
599+
`tls.connect()` returns a [`tls.TLSSocket`][] object.
600600

601601
Here is an example of a client of echo server as described previously:
602602

@@ -703,12 +703,12 @@ and the cleartext one is used as a replacement for the initial encrypted stream.
703703
automatically reject clients with invalid certificates. Only applies to
704704
servers with `requestCert` enabled.
705705

706-
- `options`: An object with common SSL options. See [tls.TLSSocket][].
706+
- `options`: An object with common SSL options. See [`tls.TLSSocket`][].
707707

708708
`tls.createSecurePair()` returns a SecurePair object with `cleartext` and
709709
`encrypted` stream properties.
710710

711-
NOTE: `cleartext` has the same APIs as [tls.TLSSocket][]
711+
NOTE: `cleartext` has the same APIs as [`tls.TLSSocket`][]
712712

713713
## tls.createServer(options[, secureConnectionListener])
714714

@@ -918,7 +918,7 @@ console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]
918918
[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
919919
[`tls.createServer()`]: #tls_tls_createserver_options_secureconnectionlistener
920920
[`tls.createSecurePair()`]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options
921-
[`tls.TLSSocket()`]: #tls_class_tls_tlssocket
921+
[`tls.TLSSocket`]: #tls_class_tls_tlssocket
922922
[`net.Server`]: net.html#net_class_net_server
923923
[`net.Socket`]: net.html#net_class_net_socket
924924
[`net.Server.address()`]: net.html#net_server_address

0 commit comments

Comments
 (0)