1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: make multipleResolves docs less opinionated

Browse Source 
The 'multipleResolves' event does not necessarily indicate an
error. This commit makes the documentation less opinionated, and
includes potential caveats.

PR-URL: https://github.com/nodejs/node/pull/28314
Refs: https://github.com/nodejs/node/issues/24321
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
cjihrig 2019-06-19 22:48:45 -04:00
parent f00d5bc050
commit 05359dd0db
No known key found for this signature in database
GPG Key ID: 7434390BDBE9B9C5
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/api/process.md
View File

@ -107,7 +107,7 @@ not be the same as what is originally sent.
added: v10.12.0 added: v10.12.0
--> -->
* `type` {string} The error type. One of `'resolve'` or `'reject'`. * `type` {string} The resolution type. One of `'resolve'` or `'reject'`.
* `promise` {Promise} The promise that resolved or rejected more than once. * `promise` {Promise} The promise that resolved or rejected more than once.
* `value` {any} The value with which the promise was either resolved or * `value` {any} The value with which the promise was either resolved or
rejected after the original resolve. rejected after the original resolve.
@ -119,14 +119,10 @@ The `'multipleResolves'` event is emitted whenever a `Promise` has been either:
* Rejected after resolve. * Rejected after resolve.
* Resolved after reject. * Resolved after reject.
This is useful for tracking errors in an application while using the promise This is useful for tracking potential errors in an application while using the
constructor. Otherwise such mistakes are silently swallowed due to being in a `Promise` constructor, as multiple resolutions are silently swallowed. However,
dead zone. the occurrence of this event does not necessarily indicate an error. For
example, [`Promise.race()`][] can trigger a `'multipleResolves'` event.
It is recommended to end the process on such errors, since the process could be
in an undefined state. While using the promise constructor make sure that it is
guaranteed to trigger the `resolve()` or `reject()` functions exactly once per
call and never call both functions in the same call.
```js ```js
process.on('multipleResolves', (type, promise, reason) => { process.on('multipleResolves', (type, promise, reason) => {
@ -2314,6 +2310,7 @@ cases:
[`process.kill()`]: #process_process_kill_pid_signal [`process.kill()`]: #process_process_kill_pid_signal
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn [`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
[`promise.catch()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch [`promise.catch()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
[`Promise.race()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/race
[`require()`]: globals.html#globals_require [`require()`]: globals.html#globals_require
[`require.main`]: modules.html#modules_accessing_the_main_module [`require.main`]: modules.html#modules_accessing_the_main_module
[`require.resolve()`]: modules.html#modules_require_resolve_request_options [`require.resolve()`]: modules.html#modules_require_resolve_request_options