import TransformFormat from 'typhonjs-escomplex-commons/src/transform/TransformFormat.js'

public class | source

TransformFormat

Static Method Summary

Static Public Methods
public static	addFormat(format: object) Adds a formatter to the static Map by type: `format.type`.
public static	forEach(callback: function, thisArg: object) Invokes the callback for each stored formatter.
public static	forEachExt(extension: string, callback: function, thisArg: object) Provides a `forEach` variation that invokes the callback if the given extension matches that of a stored formatter.
public static	forEachType(type: string, callback: function, thisArg: object) Provides a `forEach` variation that invokes the callback if the given type matches that of a stored formatter.
public static	format(report: ClassReport \| MethodReport \| ModuleReport \| ProjectReport, name: string, options: object): string Formats a given ModuleReport or ProjectReport via the formatter of the requested type.
public static	getFormats(reportType: ReportType): string[] Returns the supported format file extension types.
public static	isFormat(name: string): boolean Returns whether a given formatter by name is available.
public static	isSupported(name: string, reportType: ReportType): boolean Returns whether a given formatter by name is supports a given report.
public static	removeFormat(name: string) Removes a formatter from the static Map by name.

Adds a formatter to the static Map by type: format.type.

Name	Type	Attribute	Description
format	object		An instance of an object conforming to the module / project transform format API.

Name

Type

Attribute

Description

format

An instance of an object conforming to the module / project transform format API.

Invokes the callback for each stored formatter.

Name	Type	Attribute	Description
callback	function		A callback function.
thisArg	object		(Optional) this context.

Name

Type

Attribute

Description

callback

A callback function.

thisArg

(Optional) this context.

Provides a forEach variation that invokes the callback if the given extension matches that of a stored formatter.

Provides a forEach variation that invokes the callback if the given type matches that of a stored formatter.

Formats a given ModuleReport or ProjectReport via the formatter of the requested type.

Name	Type	Attribute	Description
report	ClassReport \| MethodReport \| ModuleReport \| ProjectReport		A report to format.
name	string		The name of formatter to invoke.
options	object		(Optional) One or more optional parameters to pass to the formatter.