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 Type Description
enabled boolean Whether to generate an API report.
reportFileName string The filename for the API report files. It will be combined with reportFolder or reportTempFolder to produce a full output filename.
reportFolder string Specifies the folder where the API report file is written. The file name portion is determined by the reportFileName setting.
reportTempFolder string Specifies the folder where the temporary report file is written. The file name portion is determined by the reportFileName setting.