report

A representation of a Diagnostic Report

Ƭ ReportLike: DiagnosticReport | Report

Either a Report or an object with all of the required props. See Report.isReportLike

▸ createReport(rawReport: DiagnosticReport | Report, filepath: string): Readonly‹Report›

Creates a read-only Report from a ReportLike value. Use this instead of new Report()!

Parameters:

Returns: Readonly‹Report›

▸ isReport(value: any): boolean

Returns true if the value is an object having a property report-toolkit-report Symbol with value true.

Parameters:

Returns: boolean

▸ isReportLike(value: any): boolean

Returns true if value has all expected root properties of a Diagnostic Report (as returned by process.report.getReport()), or is a Report.

Parameters:

Returns: boolean