diff options
| author | Moshe Atlow <moshe@atlow.co.il> | 2023-04-29 09:57:08 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-29 06:57:08 +0000 |
| commit | adf332be32a32120b2d4bcac2efe6ad8f9a6d37d (patch) | |
| tree | 5162badff2f2ef54fbbfa64fb214a49fcae2b2aa /doc/api | |
| parent | c9683618296fae63a5f6253dd5d1ea3b00a51d89 (diff) | |
| download | node-new-adf332be32a32120b2d4bcac2efe6ad8f9a6d37d.tar.gz | |
assert: deprecate callTracker
PR-URL: https://github.com/nodejs/node/pull/47740
Fixes: https://github.com/nodejs/node/issues/47492
Reviewed-By: Erick Wendel <erick.workspace@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/assert.md | 12 | ||||
| -rw-r--r-- | doc/api/deprecations.md | 17 |
2 files changed, 27 insertions, 2 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index 1467d633c2..d0ef28e367 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -221,11 +221,18 @@ try { added: - v14.2.0 - v12.19.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/47740 + description: the `assert.CallTracker` class has been deprecated and will be + removed in a future version. --> -> Stability: 1 - Experimental +> Stability: 0 - Deprecated -This feature is currently experimental and behavior might still change. +This feature is deprecated and will be removed in a future version. +Please consider using alternatives such as the +[`mock`][] helper function. ### `new assert.CallTracker()` @@ -2559,6 +2566,7 @@ argument. [`assert.strictEqual()`]: #assertstrictequalactual-expected-message [`assert.throws()`]: #assertthrowsfn-error-message [`getColorDepth()`]: tty.md#writestreamgetcolordepthenv +[`mock`]: test.md#mocking [`process.on('exit')`]: process.md#event-exit [`tracker.calls()`]: #trackercallsfn-exact [`tracker.verify()`]: #trackerverify diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 47082e696b..7be9876e4c 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -3363,6 +3363,21 @@ Type: Runtime In a future version of Node.js, the `asyncResource` property will no longer be added when a function is bound to an `AsyncResource`. +### DEP0173: the `assert.CallTracker` class + +<!-- YAML +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/47740 + description: Documentation-only deprecation. +--> + +Type: Documentation-only + +In a future version of Node.js, [`assert.CallTracker`][], +will be removed. +Consider using alternatives such as the [`mock`][] helper function. + [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 @@ -3386,6 +3401,7 @@ be added when a function is bound to an `AsyncResource`. [`Server.listen({fd: <number>})`]: net.md#serverlistenhandle-backlog-callback [`SlowBuffer`]: buffer.md#class-slowbuffer [`WriteStream.open()`]: fs.md#class-fswritestream +[`assert.CallTracker`]: assert.md#class-assertcalltracker [`assert`]: assert.md [`asyncResource.runInAsyncScope()`]: async_context.md#asyncresourceruninasyncscopefn-thisarg-args [`buffer.subarray`]: buffer.md#bufsubarraystart-end @@ -3443,6 +3459,7 @@ be added when a function is bound to an `AsyncResource`. [`message.socket`]: http.md#messagesocket [`message.trailersDistinct`]: http.md#messagetrailersdistinct [`message.trailers`]: http.md#messagetrailers +[`mock`]: test.md#mocking [`module.createRequire()`]: module.md#modulecreaterequirefilename [`os.networkInterfaces()`]: os.md#osnetworkinterfaces [`os.tmpdir()`]: os.md#ostmpdir |