Skip to content

Commit

Permalink
doc: add migration paths for deprecated utils
Browse files Browse the repository at this point in the history
PR-URL: #50488
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
  • Loading branch information
marco-ippolito authored and nodejs-github-bot committed Nov 27, 2023
1 parent e96cd25 commit 900d79c
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 15 deletions.
53 changes: 39 additions & 14 deletions doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -1005,7 +1005,8 @@ changes:

Type: Runtime

The [`util.isBoolean()`][] API is deprecated.
The [`util.isBoolean()`][] API is deprecated. Please use
`typeof arg === 'boolean'` instead.

### DEP0046: `util.isBuffer()`

Expand Down Expand Up @@ -1052,7 +1053,8 @@ changes:

Type: Runtime

The [`util.isDate()`][] API is deprecated.
The [`util.isDate()`][] API is deprecated. Please use
`arg instanceof Date` instead.

### DEP0048: `util.isError()`

Expand Down Expand Up @@ -1100,7 +1102,8 @@ changes:

Type: Runtime

The [`util.isFunction()`][] API is deprecated.
The [`util.isFunction()`][] API is deprecated. Please use
`typeof arg === 'function'` instead.

### DEP0050: `util.isNull()`

Expand All @@ -1123,7 +1126,8 @@ changes:

Type: Runtime

The [`util.isNull()`][] API is deprecated.
The [`util.isNull()`][] API is deprecated. Please use
`arg === null` instead.

### DEP0051: `util.isNullOrUndefined()`

Expand All @@ -1146,7 +1150,8 @@ changes:

Type: Runtime

The [`util.isNullOrUndefined()`][] API is deprecated.
The [`util.isNullOrUndefined()`][] API is deprecated. Please use
`arg === null || arg === undefined` instead.

### DEP0052: `util.isNumber()`

Expand All @@ -1169,7 +1174,8 @@ changes:

Type: Runtime

The [`util.isNumber()`][] API is deprecated.
The [`util.isNumber()`][] API is deprecated. Please use
`typeof arg === 'number'` instead.

### DEP0053: `util.isObject()`

Expand All @@ -1192,7 +1198,8 @@ changes:

Type: Runtime

The [`util.isObject()`][] API is deprecated.
The [`util.isObject()`][] API is deprecated. Please use
`arg && typeof arg === 'object'` instead.

### DEP0054: `util.isPrimitive()`

Expand All @@ -1215,7 +1222,9 @@ changes:

Type: Runtime

The [`util.isPrimitive()`][] API is deprecated.
The [`util.isPrimitive()`][] API is deprecated. Please use
`arg === null || (typeof arg !=='object' && typeof arg !== 'function')`
instead.

### DEP0055: `util.isRegExp()`

Expand All @@ -1238,7 +1247,8 @@ changes:

Type: Runtime

The [`util.isRegExp()`][] API is deprecated.
The [`util.isRegExp()`][] API is deprecated. Please use
`arg instanceof RegExp` instead.

### DEP0056: `util.isString()`

Expand All @@ -1261,7 +1271,8 @@ changes:

Type: Runtime

The [`util.isString()`][] API is deprecated.
The [`util.isString()`][] API is deprecated. Please use
`typeof arg === 'string'` instead.

### DEP0057: `util.isSymbol()`

Expand All @@ -1284,7 +1295,8 @@ changes:

Type: Runtime

The [`util.isSymbol()`][] API is deprecated.
The [`util.isSymbol()`][] API is deprecated. Please use
`typeof arg === 'symbol'` instead.

### DEP0058: `util.isUndefined()`

Expand All @@ -1307,7 +1319,8 @@ changes:

Type: Runtime

The [`util.isUndefined()`][] API is deprecated.
The [`util.isUndefined()`][] API is deprecated. Please use
`arg === undefined` instead.

### DEP0059: `util.log()`

Expand All @@ -1326,7 +1339,17 @@ changes:

Type: Runtime

The [`util.log()`][] API is deprecated.
The [`util.log()`][] API has been deprecated because it's an unmaintained
legacy API that was exposed to user land by accident. Instead,
consider the following alternatives based on your specific needs:

* **Third-Party Logging Libraries**

* **Use `console.log(new Date().toLocaleString(), message)`**

By adopting one of these alternatives, you can transition away from `util.log()`
and choose a logging strategy that aligns with the specific
requirements and complexity of your application.

### DEP0060: `util._extend()`

Expand All @@ -1345,7 +1368,9 @@ changes:

Type: Runtime

The [`util._extend()`][] API is deprecated.
The [`util._extend()`][] API is deprecated because it's an unmaintained
legacy API that was exposed to user land by accident.
Please use `target = Object.assign(target, source)` instead.

### DEP0061: `fs.SyncWriteStream`

Expand Down
2 changes: 1 addition & 1 deletion lib/util.js
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ module.exports = {
'Please use `arg !== null && typeof arg === "object"` instead.',
'DEP0053'),
isDate: deprecate(types.isDate,
'The `util.isDate API is deprecated. Please use `arg instanceof Error` instead.',
'The `util.isDate` API is deprecated. Please use `arg instanceof Date` instead.',
'DEP0047'),
isError: deprecate(isError,
'The `util.isError` API is deprecated. ' +
Expand Down

0 comments on commit 900d79c

Please sign in to comment.