import FormatText from 'typhonjs-escomplex-commons/src/transform/formats/text/FormatText.js'

public class | source

FormatText

Extends:

AbstractFormatText → FormatText

Direct Subclass:

FormatMarkdown, FormatMarkdown

Provides a format transform for ModuleReport / ProjectReport instances converting them to plain text.

Constructor Summary

Public Constructor
public	constructor(headers: {}, keys: {}, adjacencyFormatName: string, visibilityFormatName: 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.

Private Members
private	_adjacencyFormatName: *
private	_visibilityFormatName: *

Method Summary

Public Methods
public	isSupported(reportType: ReportType): boolean Returns whether a given ReportType is supported by this format transform.

Private Methods
private	_formatProject(projectReport: ProjectReport, options: object): string Formats a project report as plain text.

Inherited Summary

From class AbstractFormatText
private	_headers: *
private	_keys: *
public	formatReport(report: ClassReport \| MethodReport \| ModuleReport \| ProjectReport, options: object): string Formats a report as plain text.
protected	_formatProject(projectReport: ProjectReport, options: object): string Formats a project report as plain text.
private	_formatClass(classReport: ClassReport, options: object, prepend: string): string Formats a class report.
private	_formatClasses(classReports: Array<ClassReport>, options: object, prepend: string): string Formats a module reports methods array.
private	_formatEntries(report: object, entries: Array<string> \| Array<string \| StringUtil.SafeEntry>, prepend: string, parentPrepend: string): string \| Array<string> Formats entries for a given report based on an array of accessor entries.
private	_formatMethod(methodReport: MethodReport, options: object, prepend: string, isModule: boolean): string Formats a method report.
private	_formatMethods(methodReports: Array<ClassMethodReport \| ClassMethodReport>, options: object, prepend: string, isModule: boolean): string Formats a module reports methods array.
private	_formatModule(report: ModuleReport, options: object): string Formats a module report as plain text.
private	_formatModuleReport(moduleReport: ModuleReport, reportsAvailable: boolean, options: object): string Formats a module report.
private	_formatProjectReport(projectReport: ProjectReport, options: object): string Formats a project report.

Public Constructors

public constructor(headers: {}, keys: {}, adjacencyFormatName: string, visibilityFormatName: string) source

Override:

AbstractFormatText#constructor

Params:

Name	Type	Attribute	Description
headers	{}	optional default: {}
keys	{}	optional default: {}
adjacencyFormatName	string	optional default: text-adjacency
visibilityFormatName	string	optional default: text-visibility

Public Members

public get extension: string: string source

Gets the file extension.

Return:

string

public get name: string: string source

Gets the format name.

Return:

string

public get type: string: string source

Gets the format type.

Return:

string

Private Members

private _adjacencyFormatName: * source

private _visibilityFormatName: * source

Public Methods

public isSupported(reportType: ReportType): boolean source

Returns whether a given ReportType is supported by this format transform.

Params:

Name	Type	Attribute	Description
reportType	ReportType		A given report type.

Name

Type

Attribute

Description

reportType

ReportType

A given report type.

Return:

boolean

Private Methods

private _formatProject(projectReport: ProjectReport, options: object): string source

Formats a project report as plain text.

Override:

AbstractFormatText#_formatProject

Params:

Name	Type	Attribute	Description
projectReport	ProjectReport		A project report.
options	object		(Optional) One or more optional parameters passed to the formatter.

Name

Type

Attribute

Description

projectReport

ProjectReport

A project report.

options

object

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

Return:

string

Return Properties:

Name	Type	Attribute	Description
classReport	string		An entry key found in the class report to output.
methodReport	string		An entry key found in the method report to output.
moduleReport	string		An entry key found in the module report to output.