diff --git a/doc/api/cli.md b/doc/api/cli.md index 0f1e24222dc666..c050c177cfe06d 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -619,6 +619,9 @@ warning will be written to stderr instead. +> Stability: 1 - Experimental + Enables the report to be triggered on fatal errors (internal errors within the Node.js runtime such as out of memory) that lead to termination of the application. Useful to inspect various diagnostic data elements such as heap, @@ -659,6 +667,9 @@ error. -> Stability: 1 - Experimental - * {Object} `process.report` is an object whose methods are used to generate diagnostic @@ -1768,10 +1770,12 @@ reports for the current process. Additional documentation is available in the ### `process.report.directory` -> Stability: 1 - Experimental - * {string} Directory where the report is written. The default value is the empty string, @@ -1785,10 +1789,12 @@ console.log(`Report directory is ${process.report.directory}`); ### `process.report.filename` -> Stability: 1 - Experimental - * {string} Filename where the report is written. If set to the empty string, the output @@ -1802,10 +1808,12 @@ console.log(`Report filename is ${process.report.filename}`); ### `process.report.getReport([err])` -> Stability: 1 - Experimental - * `err` {Error} A custom error used for reporting the JavaScript stack. * Returns: {Object} @@ -1843,10 +1851,12 @@ console.log(`Report on fatal error: ${process.report.reportOnFatalError}`); ### `process.report.reportOnSignal` -> Stability: 1 - Experimental - * {boolean} If `true`, a diagnostic report is generated when the process receives the @@ -1859,10 +1869,12 @@ console.log(`Report on signal: ${process.report.reportOnSignal}`); ### `process.report.reportOnUncaughtException` -> Stability: 1 - Experimental - * {boolean} If `true`, a diagnostic report is generated on uncaught exception. @@ -1874,10 +1886,12 @@ console.log(`Report on exception: ${process.report.reportOnUncaughtException}`); ### `process.report.signal` -> Stability: 1 - Experimental - * {string} The signal used to trigger the creation of a diagnostic report. Defaults to @@ -1890,10 +1904,12 @@ console.log(`Report signal: ${process.report.signal}`); ### `process.report.writeReport([filename][, err])` -> 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 diff --git a/doc/api/report.md b/doc/api/report.md index 711c1412687f08..7071c30b039e70 100644 --- a/doc/api/report.md +++ b/doc/api/report.md @@ -3,7 +3,7 @@ -> Stability: 1 - Experimental +> Stability: 2 - Stable