summaryrefslogtreecommitdiff
path: root/doc/api/process.md
diff options
context:
space:
mode:
authorRuben Bridgewater <ruben@bridgewater.de>2018-04-26 02:15:59 +0200
committerRuben Bridgewater <ruben@bridgewater.de>2018-04-29 17:10:36 +0200
commitb92c6563024044c34b48165270e8464499e3c0bb (patch)
treeb7a972210d016cc5eec09735496062fdc406df91 /doc/api/process.md
parent655430179f381412d9e2fe7657135f9bba4b8e45 (diff)
downloadandroid-node-v8-b92c6563024044c34b48165270e8464499e3c0bb.tar.gz
android-node-v8-b92c6563024044c34b48165270e8464499e3c0bb.tar.bz2
android-node-v8-b92c6563024044c34b48165270e8464499e3c0bb.zip
doc: improve process event headers
The headers should be handled as all others as well and just indicate all arguments. PR-URL: https://github.com/nodejs/node/pull/20312 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/process.md')
-rw-r--r--doc/api/process.md40
1 files changed, 19 insertions, 21 deletions
diff --git a/doc/api/process.md b/doc/api/process.md
index ad1c997ae1..c973d15e12 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -45,6 +45,8 @@ the IPC channel is closed.
added: v0.1.7
-->
+* `code` {integer}
+
The `'exit'` event is emitted when the Node.js process is about to exit as a
result of either:
@@ -56,7 +58,7 @@ all `'exit'` listeners have finished running the Node.js process will terminate.
The listener callback function is invoked with the exit code specified either
by the [`process.exitCode`][] property, or the `exitCode` argument passed to the
-[`process.exit()`] method, as the only argument.
+[`process.exit()`] method.
```js
process.on('exit', (code) => {
@@ -82,16 +84,15 @@ process.on('exit', (code) => {
added: v0.5.10
-->
+* `message` {Object} a parsed JSON object or primitive value.
+* `sendHandle` {net.Server|net.Socket} a [`net.Server`][] or [`net.Socket`][]
+ object, or undefined.
+
If the Node.js process is spawned with an IPC channel (see the [Child Process][]
and [Cluster][] documentation), the `'message'` event is emitted whenever a
message sent by a parent process using [`childprocess.send()`][] is received by
the child process.
-The listener callback is invoked with the following arguments:
-* `message` {Object} a parsed JSON object or primitive value.
-* `sendHandle` {net.Server|net.Socket} a [`net.Server`][] or [`net.Socket`][]
- object, or undefined.
-
The message goes through serialization and parsing. The resulting message might
not be the same as what is originally sent.
@@ -100,13 +101,12 @@ not be the same as what is originally sent.
added: v1.4.1
-->
+* `promise` {Promise} The late handled promise.
+
The `'rejectionHandled'` event is emitted whenever a `Promise` has been rejected
and an error handler was attached to it (using [`promise.catch()`][], for
example) later than one turn of the Node.js event loop.
-The listener callback is invoked with a reference to the rejected `Promise` as
-the only argument.
-
The `Promise` object would have previously been emitted in an
`'unhandledRejection'` event, but during the course of processing gained a
rejection handler.
@@ -129,11 +129,11 @@ when the list of unhandled rejections shrinks.
```js
const unhandledRejections = new Map();
-process.on('unhandledRejection', (reason, p) => {
- unhandledRejections.set(p, reason);
+process.on('unhandledRejection', (reason, promise) => {
+ unhandledRejections.set(promise, reason);
});
-process.on('rejectionHandled', (p) => {
- unhandledRejections.delete(p);
+process.on('rejectionHandled', (promise) => {
+ unhandledRejections.delete(promise);
});
```
@@ -261,6 +261,12 @@ being emitted. Alternatively, the [`'rejectionHandled'`][] event may be used.
added: v6.0.0
-->
+* `warning` {Error} Key properties of the warning are:
+ * `name` {string} The name of the warning. **Default:** `'Warning'`.
+ * `message` {string} A system-provided description of the warning.
+ * `stack` {string} A stack trace to the location in the code where the warning
+ was issued.
+
The `'warning'` event is emitted whenever Node.js emits a process warning.
A process warning is similar to an error in that it describes exceptional
@@ -269,14 +275,6 @@ are not part of the normal Node.js and JavaScript error handling flow.
Node.js can emit warnings whenever it detects bad coding practices that could
lead to sub-optimal application performance, bugs, or security vulnerabilities.
-The listener function is called with a single `warning` argument whose value is
-an `Error` object. There are three key properties that describe the warning:
-
-* `name` {string} The name of the warning (currently `'Warning'` by default).
-* `message` {string} A system-provided description of the warning.
-* `stack` {string} A stack trace to the location in the code where the warning
- was issued.
-
```js
process.on('warning', (warning) => {
console.warn(warning.name); // Print the warning name