Home > @microsoft/api-extractor > IConfigTsdocMetadata > tsdocMetadataFilePath

IConfigTsdocMetadata.tsdocMetadataFilePath property

Specifies where the TSDoc metadata file should be written.

Signature:

tsdocMetadataFilePath?: string;

Remarks

The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as <projectFolder>.

The default value is <lookup>, which causes the path to be automatically inferred from the tsdocMetadata, typings or main fields of the project’s package.json. If none of these fields are set, the lookup falls back to tsdoc-metadata.json in the package folder.