Skip to content

Commit c8725f5

Browse files
estliberitasrvagg
authored andcommitted
doc: fix links in tls, cluster docs
Fix missing links described in #5322. PR-URL: #5364 Reviewed-By: Roman Reiss <[email protected]>
1 parent f349a9a commit c8725f5

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
@@ -72,7 +72,7 @@ server-side resources, which makes it a potential vector for denial-of-service
7272
attacks.
7373

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

7878
- `tls.CLIENT_RENEG_LIMIT`: renegotiation limit, default is 3.
@@ -155,7 +155,7 @@ is expensive.
155155

156156
## Class: CryptoStream
157157

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

160160
This is an encrypted stream.
161161

@@ -190,7 +190,7 @@ connections using TLS or SSL.
190190
When a client connection emits an `'error'` event before secure connection is
191191
established - it will be forwarded here.
192192

193-
`tlsSocket` is the [tls.TLSSocket][] that the error originated from.
193+
`tlsSocket` is the [`tls.TLSSocket`][] that the error originated from.
194194

195195
### Event: 'newSession'
196196

@@ -272,7 +272,7 @@ server.on('resumeSession', (id, cb) => {
272272
`function (tlsSocket) {}`
273273

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

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

652-
`tls.connect()` returns a [tls.TLSSocket][] object.
652+
`tls.connect()` returns a [`tls.TLSSocket`][] object.
653653

654654
Here is an example of a client of echo server as described previously:
655655

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

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

761761
`tls.createSecurePair()` returns a SecurePair object with `cleartext` and
762762
`encrypted` stream properties.
763763

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

766766
## tls.createServer(options[, secureConnectionListener])
767767

@@ -978,7 +978,7 @@ console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]
978978
[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
979979
[`tls.createServer()`]: #tls_tls_createserver_options_secureconnectionlistener
980980
[`tls.createSecurePair()`]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options
981-
[`tls.TLSSocket()`]: #tls_class_tls_tlssocket
981+
[`tls.TLSSocket`]: #tls_class_tls_tlssocket
982982
[`net.Server`]: net.html#net_class_net_server
983983
[`net.Socket`]: net.html#net_class_net_socket
984984
[`net.Server.address()`]: net.html#net_server_address

0 commit comments

Comments
 (0)