Rush StackShopBlogEvents
Skip to main content

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

IConfigApiReport.tagsToReport property​

Specifies a list of TSDoc tags that should be reported in the API report file for items whose documentation contains them.

Signature:

tagsToReport?: Readonly<Record<`@${string}`, boolean>>;

Remarks​

Tag names must begin with @.

This list may include standard TSDoc tags as well as custom ones. For more information on defining custom TSDoc tags, see here.

Note that an item's release tag will always reported; this behavior cannot be overridden.

Example 1​

Omitting default tags To omit the @sealed and @virtual tags from API reports, you would specify tagsToReport as follows:

"tagsToReport": {
 "@sealed": false,
 "@virtual": false
}

Example 2​

Including additional tags To include additional tags to the set included in API reports, you could specify tagsToReport like this:

"tagsToReport": {
 "@customTag": true
}

This will result in @customTag being included in addition to the default tags.