import FormatMarkdown from 'typhonjs-escomplex-commons/src/transform/formats/markdown/FormatMarkdown.js'

public class | source

FormatMarkdown

Provides a format transform for ModuleReport / ProjectReport instances converting them to a markdown string.

Constructor Summary

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

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

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.

From class FormatText
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	_adjacencyFormatName: *
private	_visibilityFormatName: *
public	isSupported(reportType: ReportType): boolean Returns whether a given ReportType is supported by this format transform.
private	_formatProject(projectReport: ProjectReport, options: object): string Formats a project report as plain text.

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

Gets the file extension.

Gets the format name.