Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: mark process.report as experimental #28653

Merged
merged 1 commit into from
Jul 14, 2019
Merged

doc: mark process.report as experimental #28653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions doc/api/process.md
View file
Open in desktop
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