Skip to content

Commit

Permalink
doc: return type of crypto.getFips() may change
Browse files Browse the repository at this point in the history
Document that the return type of `crypto.getFips()` may change in a
future semver-major release from a `number` to a `boolean`.

PR-URL: #32580
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Signed-off-by: Richard Lau <riclau@uk.ibm.com>
  • Loading branch information
richardlau authored and targos committed Apr 11, 2020
1 parent cf4f188 commit 7f971b3
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -2309,7 +2309,8 @@ added: v10.0.0
-->

* Returns: {number} `1` if and only if a FIPS compliant crypto provider is
currently in use, `0` otherwise.
currently in use, `0` otherwise. A future semver-major release may change
the return type of this API to a {boolean}.

### `crypto.getHashes()`
<!-- YAML
Expand Down

0 comments on commit 7f971b3

Please sign in to comment.