Skip to content

doc: document return values of crypto methods #66301

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.

Sign up for GitHub

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

Open
BIGSUS24 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

doc: document return values of crypto methods #66301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1488,6 +1488,7 @@ added: v0.5.0

* `privateKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}
* `encoding` {string} The [encoding][] of the `privateKey` string.
* Returns: {DiffieHellman} The `DiffieHellman` object itself.

Sets the Diffie-Hellman private key. If the `encoding` argument is provided,
`privateKey` is expected
Expand All @@ -1506,6 +1507,7 @@ added: v0.5.0

* `publicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}
* `encoding` {string} The [encoding][] of the `publicKey` string.
* Returns: {DiffieHellman} The `DiffieHellman` object itself.

Sets the Diffie-Hellman public key. If the `encoding` argument is provided,
`publicKey` is expected
Expand Down Expand Up @@ -1791,6 +1793,7 @@ added: v0.11.14

* `privateKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}
* `encoding` {string} The [encoding][] of the `privateKey` string.
* Returns: {ECDH} The `ECDH` object itself.

Sets the EC Diffie-Hellman private key.
If `encoding` is provided, `privateKey` is expected
Expand Down Expand Up @@ -2085,6 +2088,7 @@ changes:

* `data` {string|Buffer|TypedArray|DataView}
* `inputEncoding` {string} The [encoding][] of the `data` string.
* Returns: {Hash} The `Hash` object itself.

Updates the hash content with the given `data`, the encoding of which
is given in `inputEncoding`.
Expand Down Expand Up @@ -2245,6 +2249,7 @@ changes:

* `data` {string|Buffer|TypedArray|DataView}
* `inputEncoding` {string} The [encoding][] of the `data` string.
* Returns: {Hmac} The `Hmac` object itself.

Updates the `Hmac` content with the given `data`, the encoding of which
is given in `inputEncoding`.
Expand Down Expand Up @@ -2828,6 +2833,7 @@ changes:

* `data` {string|Buffer|TypedArray|DataView}
* `inputEncoding` {string} The [encoding][] of the `data` string.
* Returns: {Sign} The `Sign` object itself.

Updates the `Sign` content with the given `data`, the encoding of which
is given in `inputEncoding`.
Expand Down Expand Up @@ -2870,6 +2876,7 @@ changes:

* `data` {string|Buffer|TypedArray|DataView}
* `inputEncoding` {string} The [encoding][] of the `data` string.
* Returns: {Verify} The `Verify` object itself.

Updates the `Verify` content with the given `data`, the encoding of which
is given in `inputEncoding`.
Expand Down
Loading