Home > @microsoft/api-extractor > IConfigMessageReportingRule

IConfigMessageReportingRule interface

Configures reporting for a given message identifier.

Signature:

export interface IConfigMessageReportingRule 

Remarks

This is part of the IConfigFile structure.

Properties

Property Type Description
addToApiReportFile boolean When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), then the message will be written inside that file; otherwise, the message is instead logged according to the logLevel option.
logLevel ExtractorLogLevel Specifies whether the message should be written to the the tool’s output log.