Skip to main content
ProcessReport - node__process.d.ts - Node documentation
interface ProcessReport

Usage in Deno

```typescript import { type ProcessReport } from "node:node__process.d.ts"; ```

Properties

compact: boolean
Write reports in a compact format, single-line JSON, more easily consumable by log processing systems than the default multi-line format designed for human consumption.
directory: string
Directory where the report is written. The default value is the empty string, indicating that reports are written to the current working directory of the Node.js process.
filename: string
Filename where the report is written. If set to the empty string, the output filename will be comprised of a timestamp, PID, and sequence number. The default value is the empty string.
If true, a diagnostic report is generated on fatal errors, such as out of memory errors or failed C++ assertions.
reportOnSignal: boolean
If true, a diagnostic report is generated when the process receives the signal specified by process.report.signal.
If true, a diagnostic report is generated on uncaught exception.
The signal used to trigger the creation of a diagnostic report.

Methods

getReport(err?: Error): object
Returns a JavaScript Object representation of a diagnostic report for the running process. The report's JavaScript stack trace is taken from `err`, if present.
writeReport(
fileName?: string,
err?: Error,
): string
Writes a diagnostic report to a file. If filename is not provided, the default filename includes the date, time, PID, and a sequence number. The report's JavaScript stack trace is taken from `err`, if present. If the value of filename is set to `'stdout'` or `'stderr'`, the report is written to the stdout or stderr of the process respectively.
writeReport(err?: Error): string