summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2019-07-12 08:57:40 -0400
committerMichaël Zasso <targos@protonmail.com>2019-07-20 11:10:25 +0200
commit7a4062ab88747ca2367ed7b39d31b78630586a30 (patch)
tree4a79168522308b00c6b390326ff5a9792fb2764d /doc
parent5b5c8196c3f8dcfd216fd4fdef42fe100d9b7275 (diff)
downloadandroid-node-v8-7a4062ab88747ca2367ed7b39d31b78630586a30.tar.gz
android-node-v8-7a4062ab88747ca2367ed7b39d31b78630586a30.tar.bz2
android-node-v8-7a4062ab88747ca2367ed7b39d31b78630586a30.zip
doc: mark process.report as experimental
Everything under process.report is experimental. This commit adds the missing stability index entries. PR-URL: https://github.com/nodejs/node/pull/28653 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/process.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/api/process.md b/doc/api/process.md
index c5833e5bf4..826877381c 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -1684,6 +1684,8 @@ relied upon to exist.
added: v11.8.0
-->
+> Stability: 1 - Experimental
+
* {Object}
`process.report` is an object whose methods are used to generate diagnostic
@@ -1695,6 +1697,8 @@ reports for the current process. Additional documentation is available in the
added: v11.12.0
-->
+> Stability: 1 - Experimental
+
* {string}
Directory where the report is written. The default value is the empty string,
@@ -1710,6 +1714,8 @@ console.log(`Report directory is ${process.report.directory}`);
added: v11.12.0
-->
+> Stability: 1 - Experimental
+
* {string}
Filename where the report is written. If set to the empty string, the output
@@ -1725,6 +1731,8 @@ console.log(`Report filename is ${process.report.filename}`);
added: v11.8.0
-->
+> Stability: 1 - Experimental
+
* `err` {Error} A custom error used for reporting the JavaScript stack.
* Returns: {Object}
@@ -1748,6 +1756,8 @@ Additional documentation is available in the [report documentation][].
added: v11.12.0
-->
+> Stability: 1 - Experimental
+
* {boolean}
If `true`, a diagnostic report is generated on fatal errors, such as out of
@@ -1762,6 +1772,8 @@ console.log(`Report on fatal error: ${process.report.reportOnFatalError}`);
added: v11.12.0
-->
+> Stability: 1 - Experimental
+
* {boolean}
If `true`, a diagnostic report is generated when the process receives the
@@ -1776,6 +1788,8 @@ console.log(`Report on signal: ${process.report.reportOnSignal}`);
added: v11.12.0
-->
+> Stability: 1 - Experimental
+
* {boolean}
If `true`, a diagnostic report is generated on uncaught exception.
@@ -1789,6 +1803,8 @@ console.log(`Report on exception: ${process.report.reportOnUncaughtException}`);
added: v11.12.0
-->
+> Stability: 1 - Experimental
+
* {string}
The signal used to trigger the creation of a diagnostic report. Defaults to
@@ -1803,6 +1819,8 @@ console.log(`Report signal: ${process.report.signal}`);
added: v11.8.0
-->
+> Stability: 1 - Experimental
+
* `filename` {string} Name of the file where the report is written. This
should be a relative path, that will be appended to the directory specified in
`process.report.directory`, or the current working directory of the Node.js