From b9da063ae9034b3fd8207791ef78a5e769a5eb0d Mon Sep 17 00:00:00 2001
From: Richard Lau <riclau@uk.ibm.com>
Date: Thu, 2 Apr 2020 16:22:08 -0400
Subject: [PATCH] doc: return type of `crypto.getFips()` may change
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Document that the return type of `crypto.getFips()` may change in a
future semver-major release from a `number` to a `boolean`.

PR-URL: https://github.com/nodejs/node/pull/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>
---
 doc/api/crypto.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 351f32c11f6220..498efbf1812e2b 100644
--- 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