import FormatMarkdownAdjacency from 'typhonjs-escomplex-commons/src/transform/formats/markdown/FormatMarkdownAdjacency.js'
FormatMarkdownAdjacency
Extends:
Provides a format transform for ModuleReport / ProjectReport instances converting a matrix list into markdown.
Constructor Summary
Public Constructor | ||
public |
constructor(headers: {}, keys: {}) |
Member Summary
Public Members | ||
public get |
Gets the file extension. |
|
public get |
Gets the format name. |
Inherited Summary
From class AbstractTextMatrix | ||
private |
_headers: * |
|
private |
_keys: * |
|
public |
formatReport(report: ClassReport | MethodReport | ModuleReport | ProjectReport, options: object): string Formats a report as plain text. |
|
public |
isSupported(reportType: ReportType): boolean Returns whether a given ReportType is supported by this format transform. |
|
private |
_formatMatrixList(projectReport: ProjectReport, matrixList: Array<{row: number, cols: number[]}>, options: object): string{row:> Returns a string representing the adjacency relationships by printing out the report index followed by
dependent ModuleReport indices / |
|
private |
_formatProject(projectReport: ProjectReport, options: object): string Formats a matrix list stored in a ProjectReport. |
From class FormatTextAdjacency | ||
public get |
Gets the file extension. |
|
public get |
Gets the format name. |
|
public get |
Gets the format type. |
Public Constructors
public constructor(headers: {}, keys: {}) source
Override:
FormatTextAdjacency#constructorParams:
Name | Type | Attribute | Description |
headers | {} |
|
|
keys | {} |
|
Public Members
public get extension: string: string source
Gets the file extension.