doc: return type of crypto.getFips() may change

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 <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Signed-off-by: Richard Lau <[email protected]>
nodejs · Apr 11, 2020 · 7f971b3 · 7f971b3
1 parent cf4f188
commit 7f971b3
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
@@ -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