Home > @microsoft/api-extractor > IConfigApiReport

IConfigApiReport interface

Configures how the API report files (*.api.md) will be generated.

Signature:

export interface IConfigApiReport 

Remarks

This is part of the IConfigFile structure.

Properties

Property	Modifiers	Type	Description
enabled		boolean	Whether to generate an API report.
includeForgottenExports?		boolean	(Optional) Whether "forgotten exports" should be included in the API report file.
reportFileName?		string	(Optional) The base filename for the API report files, to be combined with IConfigApiReport.reportFolder or IConfigApiReport.reportTempFolder to produce the full file path.
reportFolder?		string	(Optional) Specifies the folder where the API report file is written. The file name portion is determined by the reportFileName setting.
reportTempFolder?		string	(Optional) Specifies the folder where the temporary report file is written. The file name portion is determined by the reportFileName setting.
reportVariants?		ApiReportVariant[]	(Optional) The set of report variants to generate.
tagsToReport?		Readonly<Record<`@${string}`, boolean>>	(Optional) Specifies a list of TSDoc tags that should be reported in the API report file for items whose documentation contains them.