Home Manual Reference Source Test Repository
public class | source

FormatTextModules

Extends:

src/transform/formats/text/AbstractFormatText.js~AbstractFormatTest → FormatTextModules

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

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.

Method Summary

Public Methods
public

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

Public Constructors

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

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

Public Methods

public isSupported(reportType: ReportType): boolean source

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

Params:

NameTypeAttributeDescription
reportType ReportType

A given report type.

Return:

boolean