Home Manual Reference Source Test Repository
public class | source

FormatTextAdjacency

Extends:

AbstractTextMatrix → FormatTextAdjacency

Provides a format transform for ModuleReport / ProjectReport instances converting a matrix list into plain text.

Constructor Summary

Public Constructor
public

constructor(headers: {}, keys: {})

Member Summary

Public Members
public get

Gets the file extension.

public get

Gets the format name.

public get

Gets the format type.

Inherited Summary

From class AbstractTextMatrix
private
private

_keys: *

public

Formats a report as plain text.

public

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

private

_formatMatrixList(projectReport: ProjectReport, matrixList: Array<{row: number, cols: number[]}>, options: object): string

Returns a string representing the adjacency relationships by printing out the report index followed by dependent ModuleReport indices / srcPaths.

private

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

Formats a matrix list stored in a ProjectReport.

Public Constructors

public constructor(headers: {}, keys: {}) source

Override:

AbstractTextMatrix#constructor

Params:

NameTypeAttributeDescription
headers {}
  • optional
  • default: {}
keys {}
  • optional
  • default: {}

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