Skip to content

Commit c10b216

Browse files
committed
doc: remove cryptoStream API reference
1 parent a46af03 commit c10b216

File tree

2 files changed

+34
-58
lines changed

2 files changed

+34
-58
lines changed

doc/api/deprecations.md

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66

77
Node.js APIs might be deprecated for any of the following reasons:
88

9-
* Use of the API is unsafe.
10-
* An improved alternative API is available.
11-
* Breaking changes to the API are expected in a future major release.
9+
- Use of the API is unsafe.
10+
- An improved alternative API is available.
11+
- Breaking changes to the API are expected in a future major release.
1212

1313
Node.js uses four kinds of deprecations:
1414

15-
* Documentation-only
16-
* Application (non-`node_modules` code only)
17-
* Runtime (all code)
18-
* End-of-Life
15+
- Documentation-only
16+
- Application (non-`node_modules` code only)
17+
- Runtime (all code)
18+
- End-of-Life
1919

2020
A Documentation-only deprecation is one that is expressed only within the
2121
Node.js API docs. These generate no side-effects while running Node.js.
@@ -156,17 +156,17 @@ API usability issues that can lead to accidental security issues.
156156
As an alternative, use one of the following methods of constructing `Buffer`
157157
objects:
158158

159-
* [`Buffer.alloc(size[, fill[, encoding]])`][alloc]: Create a `Buffer` with
159+
- [`Buffer.alloc(size[, fill[, encoding]])`][alloc]: Create a `Buffer` with
160160
_initialized_ memory.
161-
* [`Buffer.allocUnsafe(size)`][alloc_unsafe_size]: Create a `Buffer` with
161+
- [`Buffer.allocUnsafe(size)`][alloc_unsafe_size]: Create a `Buffer` with
162162
_uninitialized_ memory.
163-
* [`Buffer.allocUnsafeSlow(size)`][]: Create a `Buffer` with _uninitialized_
163+
- [`Buffer.allocUnsafeSlow(size)`][]: Create a `Buffer` with _uninitialized_
164164
memory.
165-
* [`Buffer.from(array)`][]: Create a `Buffer` with a copy of `array`
166-
* [`Buffer.from(arrayBuffer[, byteOffset[, length]])`][from_arraybuffer] -
165+
- [`Buffer.from(array)`][]: Create a `Buffer` with a copy of `array`
166+
- [`Buffer.from(arrayBuffer[, byteOffset[, length]])`][from_arraybuffer] -
167167
Create a `Buffer` that wraps the given `arrayBuffer`.
168-
* [`Buffer.from(buffer)`][]: Create a `Buffer` that copies `buffer`.
169-
* [`Buffer.from(string[, encoding])`][from_string_encoding]: Create a `Buffer`
168+
- [`Buffer.from(buffer)`][]: Create a `Buffer` that copies `buffer`.
169+
- [`Buffer.from(string[, encoding])`][from_string_encoding]: Create a `Buffer`
170170
that copies `string`.
171171

172172
Without `--pending-deprecation`, runtime warnings occur only for code not in
@@ -940,7 +940,7 @@ changes:
940940

941941
Type: End-of-Life
942942

943-
The [`tls.CryptoStream`][] class was removed. Please use
943+
The `tls.CryptoStream` class was removed. Please use
944944
[`tls.TLSSocket`][] instead.
945945

946946
### DEP0043: `tls.SecurePair`
@@ -1402,9 +1402,9 @@ The `util.log()` API has been removed because it's an unmaintained
14021402
legacy API that was exposed to user land by accident. Instead,
14031403
consider the following alternatives based on your specific needs:
14041404

1405-
* **Third-Party Logging Libraries**
1405+
- **Third-Party Logging Libraries**
14061406

1407-
* **Use `console.log(new Date().toLocaleString(), message)`**
1407+
- **Use `console.log(new Date().toLocaleString(), message)`**
14081408

14091409
By adopting one of these alternatives, you can transition away from `util.log()`
14101410
and choose a logging strategy that aligns with the specific
@@ -1897,19 +1897,19 @@ Since Node.js versions 4.4.0 and 5.2.0, several modules only intended for
18971897
internal usage were mistakenly exposed to user code through `require()`. These
18981898
modules were:
18991899

1900-
* `v8/tools/codemap`
1901-
* `v8/tools/consarray`
1902-
* `v8/tools/csvparser`
1903-
* `v8/tools/logreader`
1904-
* `v8/tools/profile_view`
1905-
* `v8/tools/profile`
1906-
* `v8/tools/SourceMap`
1907-
* `v8/tools/splaytree`
1908-
* `v8/tools/tickprocessor-driver`
1909-
* `v8/tools/tickprocessor`
1910-
* `node-inspect/lib/_inspect` (from 7.6.0)
1911-
* `node-inspect/lib/internal/inspect_client` (from 7.6.0)
1912-
* `node-inspect/lib/internal/inspect_repl` (from 7.6.0)
1900+
- `v8/tools/codemap`
1901+
- `v8/tools/consarray`
1902+
- `v8/tools/csvparser`
1903+
- `v8/tools/logreader`
1904+
- `v8/tools/profile_view`
1905+
- `v8/tools/profile`
1906+
- `v8/tools/SourceMap`
1907+
- `v8/tools/splaytree`
1908+
- `v8/tools/tickprocessor-driver`
1909+
- `v8/tools/tickprocessor`
1910+
- `node-inspect/lib/_inspect` (from 7.6.0)
1911+
- `node-inspect/lib/internal/inspect_client` (from 7.6.0)
1912+
- `node-inspect/lib/internal/inspect_repl` (from 7.6.0)
19131913

19141914
The `v8/*` modules do not have any exports, and if not imported in a specific
19151915
order would in fact throw errors. As such there are virtually no legitimate use
@@ -2849,8 +2849,7 @@ async function openAndClose() {
28492849
try {
28502850
filehandle = await fsPromises.open('thefile.txt', 'r');
28512851
} finally {
2852-
if (filehandle !== undefined)
2853-
await filehandle.close();
2852+
if (filehandle !== undefined) await filehandle.close();
28542853
}
28552854
}
28562855
```
@@ -2982,8 +2981,9 @@ When looking for the CommonJS modules that have required the current one,
29822981
`require.cache` and `module.children` can be used:
29832982

29842983
```js
2985-
const moduleParents = Object.values(require.cache)
2986-
.filter((m) => m.children.includes(module));
2984+
const moduleParents = Object.values(require.cache).filter((m) =>
2985+
m.children.includes(module)
2986+
);
29872987
```
29882988

29892989
### DEP0145: `socket.bufferSize`
@@ -3985,7 +3985,6 @@ When an `args` array is passed to [`child_process.execFile`][] or [`child_proces
39853985
[`timeout.ref()`]: timers.md#timeoutref
39863986
[`timeout.refresh()`]: timers.md#timeoutrefresh
39873987
[`timeout.unref()`]: timers.md#timeoutunref
3988-
[`tls.CryptoStream`]: tls.md#class-tlscryptostream
39893988
[`tls.SecureContext`]: tls.md#tlscreatesecurecontextoptions
39903989
[`tls.TLSSocket`]: tls.md#class-tlstlssocket
39913990
[`tls.checkServerIdentity()`]: tls.md#tlscheckserveridentityhostname-cert

doc/api/tls.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -553,29 +553,6 @@ appends a hint suggesting that if the root CA is installed locally,
553553
try running with the `--use-system-ca` flag to direct developers towards a
554554
secure solution, to prevent unsafe workarounds.
555555

556-
## Class: `tls.CryptoStream`
557-
558-
<!-- YAML
559-
added: v0.3.4
560-
deprecated: v0.11.3
561-
-->
562-
563-
> Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
564-
565-
The `tls.CryptoStream` class represents a stream of encrypted data. This class
566-
is deprecated and should no longer be used.
567-
568-
### `cryptoStream.bytesWritten`
569-
570-
<!-- YAML
571-
added: v0.3.4
572-
deprecated: v0.11.3
573-
-->
574-
575-
The `cryptoStream.bytesWritten` property returns the total number of bytes
576-
written to the underlying socket _including_ the bytes required for the
577-
implementation of the TLS protocol.
578-
579556
## Class: `tls.Server`
580557

581558
<!-- YAML

0 commit comments

Comments
 (0)