Skip to content

doc: mention crypto.hash() for better perf #63420

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
styfle wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −0
Open

doc: mention crypto.hash() for better perf #63420

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05c7389
doc: mention crypto.hash() for better perf
styfle May 19, 2026
22762d3
doc: apply suggestion from joyeecheung
styfle May 20, 2026
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
3 changes: 3 additions & 0 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3773,6 +3773,8 @@ using the given `algorithm`. Optional `options` argument controls stream
behavior. For XOF hash functions such as `'shake256'`, the `outputLength` option
can be used to specify the desired output length in bytes.

When the data is small (< 5MB) and readily available, [`crypto.hash()`][] is usually faster.

The `algorithm` is dependent on the available algorithms supported by the
version of OpenSSL on the platform. Examples are `'sha256'`, `'sha512'`, etc.
On recent releases of OpenSSL, `openssl list -digest-algorithms` will
Expand Down Expand Up @@ -6935,6 +6937,7 @@ See the [list of SSL OP Flags][] for details.
[`crypto.getCurves()`]: #cryptogetcurves
[`crypto.getDiffieHellman()`]: #cryptogetdiffiehellmangroupname
[`crypto.getHashes()`]: #cryptogethashes
[`crypto.hash()`]: #cryptohashalgorithm-data-options
[`crypto.privateDecrypt()`]: #cryptoprivatedecryptprivatekey-buffer
[`crypto.privateEncrypt()`]: #cryptoprivateencryptprivatekey-buffer
[`crypto.publicDecrypt()`]: #cryptopublicdecryptkey-buffer
Expand Down
Loading