import FormatJSON from 'typhonjs-escomplex-commons/src/transform/formats/json/FormatJSON.js'

public class | source

FormatJSON

Provides a format transform for ESComplex report instances converting them to a JSON string.

Member Summary

Public Members
public get	extension: string: string Gets the file extension.
public get	name: string: string Gets the format name.
public get	type: string: string Gets the format type.

Public Methods
public	formatReport(report: ClassReport \| MethodReport \| ModuleReport \| ProjectReport, options: object): string Formats a report as a JSON string.
public	isSupported(): boolean Returns whether a given ReportType is supported by this format transform.

Gets the file extension.

Gets the format name.

Gets the format type.

Formats a report as a JSON string.

Name	Type	Attribute	Description
report	ClassReport \| MethodReport \| ModuleReport \| ProjectReport		A report to format.
options	object		(Optional) One or more optional parameters passed to the formatter.

Name

Type

Attribute

Description

report

A report to format.

options

(Optional) One or more optional parameters passed to the formatter.