doc: deprecate hmac public constructor

PR-URL: #51881 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Adrian Estrada <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]>
nodejs · May 2, 2024 · 53ff3e5 · 53ff3e5
1 parent 5e78a20
commit 53ff3e5
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -3492,6 +3492,21 @@ Type: Documentation-only
 Calling `fs.Stats` class directly with `Stats()` or `new Stats()` is
 deprecated due to being internals, not intended for public use.
 
+### DEP0181: `Hmac` constructor
+
+<!-- YAML
+changes:
+  - version: REPLACEME
+    pr-url: https://github.com/nodejs/node/pull/51881
+    description: Documentation-only deprecation.
+-->
+
+Type: Documentation-only
+
+Calling `Hmac` class directly with `Hmac()` or `new Hmac()` is
+deprecated due to being internals, not intended for public use.
+Please use the [`crypto.createHmac()`][] method to create Hmac instances.
+
 [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
 [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
 [RFC 8247 Section 2.4]: https://www.rfc-editor.org/rfc/rfc8247#section-2.4
@@ -3531,6 +3546,7 @@ deprecated due to being internals, not intended for public use.
 [`crypto.createDecipher()`]: crypto.md#cryptocreatedecipheralgorithm-password-options
 [`crypto.createDecipheriv()`]: crypto.md#cryptocreatedecipherivalgorithm-key-iv-options
 [`crypto.createHash()`]: crypto.md#cryptocreatehashalgorithm-options
+[`crypto.createHmac()`]: crypto.md#cryptocreatehmacalgorithm-key-options
 [`crypto.fips`]: crypto.md#cryptofips
 [`crypto.pbkdf2()`]: crypto.md#cryptopbkdf2password-salt-iterations-keylen-digest-callback
 [`crypto.randomBytes()`]: crypto.md#cryptorandombytessize-callback