Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProcessReport

Hierarchy

  • ProcessReport

Index

Properties

directory

directory: string

Directory where the report is written. working directory of the Node.js process.

default

'' indicating that reports are written to the current

filename

filename: string

Filename where the report is written. The default value is the empty string.

default

'' the output filename will be comprised of a timestamp, PID, and sequence number.

reportOnFatalError

reportOnFatalError: boolean

If true, a diagnostic report is generated on fatal errors, such as out of memory errors or failed C++ assertions.

default

false

reportOnSignal

reportOnSignal: boolean

If true, a diagnostic report is generated when the process receives the signal specified by process.report.signal.

defaul

false

reportOnUncaughtException

reportOnUncaughtException: boolean

If true, a diagnostic report is generated on uncaught exception.

default

false

signal

signal: Signals

The signal used to trigger the creation of a diagnostic report.

default

'SIGUSR2'

Methods

getReport

  • getReport(err?: Error): string
  • Returns a JSON-formatted diagnostic report for the running process. The report's JavaScript stack trace is taken from err, if present.

    Parameters

    • Optional err: Error

    Returns string

writeReport

  • writeReport(fileName?: string): string
  • writeReport(error?: Error): string
  • 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.

    Parameters

    • Optional 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 process, if unspecified.

    Returns string

    Filename of the generated report.

  • Parameters

    • Optional error: Error

    Returns string

  • Parameters

    • Optional fileName: string
    • Optional err: Error

    Returns string

Generated using TypeDoc