Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc,crypto: add extends for derived classes #29302

Merged
merged 1 commit into from
Aug 29, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ console.log(cert.verifySpkac(Buffer.from(spkac)));
added: v0.1.94
-->

* Extends: {stream.Transform}

Instances of the `Cipher` class are used to encrypt data. The class can be
used in one of two ways:

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

* Extends: {stream.Transform}

Instances of the `Decipher` class are used to decrypt data. The class can be
used in one of two ways:

Expand Down Expand Up @@ -950,6 +954,8 @@ console.log(aliceSecret === bobSecret);
added: v0.1.92
-->

* Extends: {stream.Transform}

The `Hash` class is a utility for creating hash digests of data. It can be
used in one of two ways:

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

* Extends: {stream.Transform}

The `Hmac` class is a utility for creating cryptographic HMAC digests. It can
be used in one of two ways:

Expand Down Expand Up @@ -1252,6 +1260,8 @@ or `'private'` for private (asymmetric) keys.
added: v0.1.92
-->

* Extends: {stream.Writable}

The `Sign` class is a utility for generating signatures. It can be used in one
of two ways:

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

* Extends: {stream.Writable}

The `Verify` class is a utility for verifying signatures. It can be used in one
of two ways:

Expand Down
1 change: 1 addition & 0 deletions tools/doc/type-parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ const customTypesMap = {
'Stream': 'stream.html#stream_stream',
'stream.Duplex': 'stream.html#stream_class_stream_duplex',
'stream.Readable': 'stream.html#stream_class_stream_readable',
'stream.Transform': 'stream.html#stream_class_stream_transform',
'stream.Writable': 'stream.html#stream_class_stream_writable',

'Immediate': 'timers.html#timers_class_immediate',
Expand Down