doc: deprecate calling `promisify` on a function that returns a promise · nodejs/node@7b6a731 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 632
• Pull requests 754
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 7b6a731

Browse filesBrowse the repository at this point in the historyBrowse files

aduh95

authored and

ruyadorno

committed

doc: deprecate calling promisify on a function that returns a promise

PR-URL: #49647 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: LiviaMedeiros <livia@cirno.name> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

1 parent d316b32 commit 7b6a731
Copy full SHA for 7b6a731

2 files changed

+20Lines changed: 20 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • deprecations.md
  • util.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/deprecations.md‎

Copy file name to clipboardExpand all lines: doc/api/deprecations.md

+15Lines changed: 15 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -3378,6 +3378,20 @@ In a future version of Node.js, [`assert.CallTracker`][],
3378	3378	will be removed.
3379	3379	Consider using alternatives such as the [`mock`][] helper function.
3380	3380
	3381	+ ### DEP0174: calling `promisify` on a function that returns a `Promise`
	3382	+
	3383	+ <!-- YAML
	3384	+ changes:
	3385	+ - version: REPLACEME
	3386	+ pr-url: https://github.com/nodejs/node/pull/49647
	3387	+ description: Documentation-only deprecation.
	3388	+ -->
	3389	+
	3390	+ Type: Documentation-only
	3391	+
	3392	+ Calling [`util.promisify`][] on a function that returns a <Promise> will ignore
	3393	+ the result of said promise, which can lead to unhandled promise rejections.
	3394	+
3381	3395	[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
3382	3396	[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
3383	3397	[RFC 8247 Section 2.4]: https://www.rfc-editor.org/rfc/rfc8247#section-2.4
@@ -3518,6 +3532,7 @@ Consider using alternatives such as the [`mock`][] helper function.
3518	3532	[`util.isSymbol()`]: util.md#utilissymbolobject
3519	3533	[`util.isUndefined()`]: util.md#utilisundefinedobject
3520	3534	[`util.log()`]: util.md#utillogstring
	3535	+ [`util.promisify`]: util.md#utilpromisifyoriginal
3521	3536	[`util.types`]: util.md#utiltypes
3522	3537	[`util`]: util.md
3523	3538	[`worker.exitedAfterDisconnect`]: cluster.md#workerexitedafterdisconnect

Collapse file

‎doc/api/util.md‎

Copy file name to clipboardExpand all lines: doc/api/util.md

+5Lines changed: 5 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -1591,6 +1591,11 @@ $ node negate.js --no-logfile --logfile=test.log --color --no-color
1591	1591
1592	1592	<!-- YAML
1593	1593	added: v8.0.0
	1594	+ changes:
	1595	+ - version: REPLACEME
	1596	+ pr-url: https://github.com/nodejs/node/pull/49647
	1597	+ description: Calling `promisify` on a function that returns a `Promise` is
	1598	+ deprecated.
1594	1599	-->
1595	1600
1596	1601	* `original` {Function}

0 commit comments

Comments

0 (0)