Commit 7d81419
doc: add Hmac.digest() documentation-only deprecation (DEP0206)
Signed-off-by: anshikakalpana <anshikajain196872@gmail.com>
PR-URL: #63121
Refs: #62838
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent ececd80 commit 7d81419
1 file changed
Lines changed: 16 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4439,6 +4439,22 @@ that have proven unresolveable. See [caveats of asynchronous customization hooks | |||
| 4439 | 4439 | `module.registerHooks()` as soon as possible as `module.register()` will be | |
| 4440 | 4440 | removed in a future version of Node.js. | |
| 4441 | 4441 | ||
| 4442 | + ### DEP0206: Calling `digest()` on an already-finalized `Hmac` instance | ||
| 4443 | + | ||
| 4444 | + <!-- YAML | ||
| 4445 | + changes: | ||
| 4446 | + - version: REPLACEME | ||
| 4447 | + pr-url: https://github.com/nodejs/node/pull/63121 | ||
| 4448 | + description: Documentation-only deprecation. | ||
| 4449 | + --> | ||
| 4450 | + | ||
| 4451 | + Type: Documentation-only | ||
| 4452 | + | ||
| 4453 | + Calling `hmac.digest()` more than once returns an empty buffer instead of | ||
| 4454 | + throwing an error. This behavior is inconsistent with `hash.digest()` and | ||
| 4455 | + may lead to subtle bugs. Calling `hmac.digest()` on a finalized `Hmac` instance | ||
| 4456 | + will throw an error in a future version. | ||
| 4457 | + | ||
| 4442 | 4458 | [DEP0142]: #dep0142-repl_builtinlibs | |
| 4443 | 4459 | [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf | |
| 4444 | 4460 | [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 | |
0 commit comments