Skip to content

Commit

Permalink
doc: mark process.report as experimental
Browse files Browse the repository at this point in the history
Everything under process.report is experimental. This commit
adds the missing stability index entries.

PR-URL: nodejs#28653
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
  • Loading branch information
cjihrig committed Jul 14, 2019
1 parent e12f48e commit febdf39
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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,
Expand All @@ -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
Expand All @@ -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}

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit febdf39

Please sign in to comment.