api-extractor.extractorconfig.tagstoreport

ExtractorConfig.tagsToReport property

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

Signature:

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

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.