Commit 984894b
doc: deprecate utilisNativeError in favor of ErrorisError
PR-URL: #58262
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Jordan Harband <ljharb@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Edy Silva <edigleyssonsilva@gmail.com>1 parent 377ef3c commit 984894b
2 files changed
Lines changed: 23 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3983,6 +3983,20 @@ To make [`child_process.exec`][] invoke the default shell, either omit the | |||
| 3983 | 3983 | `shell` option, or set it to a nullish value. If the intention is not to invoke | |
| 3984 | 3984 | a shell, use [`child_process.execFile`][] instead. | |
| 3985 | 3985 | ||
| 3986 | + ### DEP0197: `util.types.isNativeError()` | ||
| 3987 | + | ||
| 3988 | + <!-- YAML | ||
| 3989 | + changes: | ||
| 3990 | + - version: | ||
| 3991 | + - REPLACEME | ||
| 3992 | + pr-url: https://github.com/nodejs/node/pull/58262 | ||
| 3993 | + description: Documentation-only deprecation. | ||
| 3994 | + --> | ||
| 3995 | + | ||
| 3996 | + Type: Documentation-only | ||
| 3997 | + | ||
| 3998 | + The [`util.types.isNativeError`][] API is deprecated. Please use [`Error.isError`][] instead. | ||
| 3999 | + | ||
| 3986 | 4000 | [DEP0142]: #dep0142-repl_builtinlibs | |
| 3987 | 4001 | [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf | |
| 3988 | 4002 | [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 | |
@@ -4001,6 +4015,7 @@ a shell, use [`child_process.execFile`][] instead. | |||
| 4001 | 4015 | [`Buffer.isBuffer()`]: buffer.md#static-method-bufferisbufferobj | |
| 4002 | 4016 | [`Cipheriv`]: crypto.md#class-cipheriv | |
| 4003 | 4017 | [`Decipheriv`]: crypto.md#class-decipheriv | |
| 4018 | + [`Error.isError`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/isError | ||
| 4004 | 4019 | [`REPLServer.clearBufferedCommand()`]: repl.md#replserverclearbufferedcommand | |
| 4005 | 4020 | [`ReadStream.open()`]: fs.md#class-fsreadstream | |
| 4006 | 4021 | [`Server.getConnections()`]: net.md#servergetconnectionscallback | |
@@ -4116,6 +4131,7 @@ a shell, use [`child_process.execFile`][] instead. | |||
| 4116 | 4131 | [`util.isArray()`]: util.md#utilisarrayobject | |
| 4117 | 4132 | [`util.promisify`]: util.md#utilpromisifyoriginal | |
| 4118 | 4133 | [`util.toUSVString()`]: util.md#utiltousvstringstring | |
| 4134 | + [`util.types.isNativeError`]: util.md#utiltypesisnativeerrorvalue | ||
| 4119 | 4135 | [`util.types`]: util.md#utiltypes | |
| 4120 | 4136 | [`util`]: util.md | |
| 4121 | 4137 | [`worker.exitedAfterDisconnect`]: cluster.md#workerexitedafterdisconnect | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3324,8 +3324,14 @@ util.types.isModuleNamespaceObject(ns); // Returns true | |||
| 3324 | 3324 | ||
| 3325 | 3325 | <!-- YAML | |
| 3326 | 3326 | added: v10.0.0 | |
| 3327 | + deprecated: REPLACEME | ||
| 3327 | 3328 | --> | |
| 3328 | 3329 | ||
| 3330 | + > Stability: 0 - Deprecated: Use [`Error.isError`][] instead. | ||
| 3331 | + | ||
| 3332 | + **Note:** As of Node.js v24, `Error.isError()` is currently slower than `util.types.isNativeError()`. | ||
| 3333 | + If performance is critical, consider benchmarking both in your environment. | ||
| 3334 | + | ||
| 3329 | 3335 | * `value` {any} | |
| 3330 | 3336 | * Returns: {boolean} | |
| 3331 | 3337 | ||
@@ -3712,6 +3718,7 @@ util.isArray({}); | |||
| 3712 | 3718 | [`'warning'`]: process.md#event-warning | |
| 3713 | 3719 | [`Array.isArray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray | |
| 3714 | 3720 | [`ArrayBuffer.isView()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView | |
| 3721 | + [`Error.isError`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/isError | ||
| 3715 | 3722 | [`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify | |
| 3716 | 3723 | [`MIMEparams`]: #class-utilmimeparams | |
| 3717 | 3724 | [`Object.assign()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign | |
0 commit comments