Home > @microsoft/api-extractor > IConfigDocModel
IConfigDocModel interface
Configures how the doc model file (*.api.json) will be generated.
Signature:
export interface IConfigDocModel
Remarks
This is part of the IConfigFile structure.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| apiJsonFilePath? | string | (Optional) The output path for the doc model file. The file extension should be ".api.json". | |
| enabled | boolean | Whether to generate a doc model file. | |
| includeForgottenExports? | boolean | (Optional) Whether "forgotten exports" should be included in the doc model file. | |
| projectFolderUrl? | string | (Optional) The base URL where the project's source code can be viewed on a website such as GitHub or Azure DevOps. This URL path corresponds to the <projectFolder> path on disk. |