Home Manual Reference Source Test Repository
public class | source

FormatMarkdownMinimal

Extends:

src/transform/formats/text/AbstractFormatText.js~AbstractFormatTestFormatTextMinimal → FormatMarkdownMinimal

Provides a format transform for ModuleReport / ProjectReport instances converting them to markdown with minimal metrics.

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 FormatTextMinimal
public get

Gets the file extension.

public get

Gets the format name.

public get

Gets the format type.

public

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

Public Constructors

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

Override:

FormatTextMinimal#constructor

Params:

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

Public Members

public get extension: string: string source

Gets the file extension.

Override:

FormatTextMinimal#extension

Return:

string

public get name: string: string source

Gets the format name.

Override:

FormatTextMinimal#name

Return:

string