diff options
| author | Richard Lau <riclau@uk.ibm.com> | 2020-04-02 23:22:08 +0300 |
|---|---|---|
| committer | Beth Griggs <Bethany.Griggs@uk.ibm.com> | 2020-04-07 18:28:21 +0300 |
| commit | d5da9708dd9b1f173acbdbbbcdad2a6cdda12b80 (patch) | |
| tree | db9685a94dd1f06be143d1fc778872efd8868a56 /doc/api | |
| parent | 8bfbb5e3b4eaf12358287e25cfeaabab60254d32 (diff) | |
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: 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>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/crypto.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 351f32c11f6..498efbf1812 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 |