Home > @microsoft/api-extractor > IConfigApiReport > reportFileName

IConfigApiReport.reportFileName property

The base filename for the API report files, to be combined with IConfigApiReport.reportFolder or IConfigApiReport.reportTempFolder to produce the full file path.

Signature:

reportFileName?: string;

Remarks

The reportFileName should not include any path separators such as \ or /. The reportFileName should not include a file extension, since API Extractor will automatically append an appropriate file extension such as .api.md. If the IConfigApiReport.reportVariants setting is used, then the file extension includes the variant name, for example my-report.public.api.md or my-report.beta.api.md. The complete variant always uses the simple extension my-report.api.md.

Previous versions of API Extractor required reportFileName to include the .api.md extension explicitly; for backwards compatibility, that is still accepted but will be discarded before applying the above rules.