Home > @microsoft/api-extractor > IConfigTsdocMetadata

IConfigTsdocMetadata interface

Configures how the tsdoc-metadata.json file will be generated.

Signature:

export interface IConfigTsdocMetadata 

Remarks

This is part of the IConfigFile structure.

Properties

Property	Modifiers	Type	Description
enabled		boolean	Whether to generate the tsdoc-metadata.json file.
tsdocMetadataFilePath?		string	(Optional) Specifies where the TSDoc metadata file should be written.