Skip to content

Commit 8c776cb

Browse files
trivikrBridgeAR
authored andcommitted
doc,crypto: add extends for derived classes
PR-URL: #29302 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 28b1a49 commit 8c776cb

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

doc/api/crypto.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,8 @@ console.log(cert.verifySpkac(Buffer.from(spkac)));
169169
added: v0.1.94
170170
-->
171171

172+
* Extends: {stream.Transform}
173+
172174
Instances of the `Cipher` class are used to encrypt data. The class can be
173175
used in one of two ways:
174176

@@ -354,6 +356,8 @@ The `cipher.update()` method can be called multiple times with new data until
354356
added: v0.1.94
355357
-->
356358

359+
* Extends: {stream.Transform}
360+
357361
Instances of the `Decipher` class are used to decrypt data. The class can be
358362
used in one of two ways:
359363

@@ -950,6 +954,8 @@ console.log(aliceSecret === bobSecret);
950954
added: v0.1.92
951955
-->
952956

957+
* Extends: {stream.Transform}
958+
953959
The `Hash` class is a utility for creating hash digests of data. It can be
954960
used in one of two ways:
955961

@@ -1044,6 +1050,8 @@ This can be called many times with new data as it is streamed.
10441050
added: v0.1.94
10451051
-->
10461052

1053+
* Extends: {stream.Transform}
1054+
10471055
The `Hmac` class is a utility for creating cryptographic HMAC digests. It can
10481056
be used in one of two ways:
10491057

@@ -1252,6 +1260,8 @@ or `'private'` for private (asymmetric) keys.
12521260
added: v0.1.92
12531261
-->
12541262

1263+
* Extends: {stream.Writable}
1264+
12551265
The `Sign` class is a utility for generating signatures. It can be used in one
12561266
of two ways:
12571267

@@ -1377,6 +1387,8 @@ This can be called many times with new data as it is streamed.
13771387
added: v0.1.92
13781388
-->
13791389

1390+
* Extends: {stream.Writable}
1391+
13801392
The `Verify` class is a utility for verifying signatures. It can be used in one
13811393
of two ways:
13821394

tools/doc/type-parser.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ const customTypesMap = {
123123
'Stream': 'stream.html#stream_stream',
124124
'stream.Duplex': 'stream.html#stream_class_stream_duplex',
125125
'stream.Readable': 'stream.html#stream_class_stream_readable',
126+
'stream.Transform': 'stream.html#stream_class_stream_transform',
126127
'stream.Writable': 'stream.html#stream_class_stream_writable',
127128

128129
'Immediate': 'timers.html#timers_class_immediate',

0 commit comments

Comments
 (0)