Skip to content
Permalink
Browse files

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>
  • Loading branch information...
trivikr committed Aug 25, 2019
1 parent ecd9842 commit c746ba4982d3ec17cd7ce38468e6cea662462a84
Showing with 13 additions and 0 deletions.
  1. +12 −0 doc/api/crypto.md
  2. +1 −0 tools/doc/type-parser.js
@@ -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:

@@ -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:

@@ -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:

@@ -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:

@@ -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:

@@ -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:

@@ -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',

0 comments on commit c746ba4

Please sign in to comment.
You can’t perform that action at this time.