RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor > IConfigFile

IConfigFile interface

Configuration options for the API Extractor tool. These options can be constructed programmatically or loaded from the api-extractor.json config file using the ExtractorConfig class.

Signature:

export interface IConfigFile 

Properties

PropertyModifiersTypeDescription
apiReport?IConfigApiReport(Optional) Configures how the API report files (*.api.md) will be generated.
bundledPackages?string[](Optional) A list of NPM package names whose exports should be treated as part of this package.
compiler?IConfigCompiler(Optional) Determines how the TypeScript compiler engine will be invoked by API Extractor.
docModel?IConfigDocModel(Optional) Configures how the doc model file (*.api.json) will be generated.
dtsRollup?IConfigDtsRollup(BETA) (Optional) Configures how the .d.ts rollup file will be generated.
enumMemberOrder?EnumMemberOrder(Optional) Specifies how API Extractor sorts members of an enum when generating api.json.
extends?string(Optional) Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects.
mainEntryPointFilePathstringSpecifies the .d.ts file to be used as the starting point for analysis. API Extractor analyzes the symbols exported by this module.
messages?IExtractorMessagesConfig(Optional) Configures how API Extractor reports error and warning messages produced during analysis.
newlineKind?'crlf' | 'lf' | 'os'(Optional) Specifies what type of newlines API Extractor should use when writing output files.
projectFolder?string(Optional) Determines the <projectFolder> token that can be used with other config file settings. The project folder typically contains the tsconfig.json and package.json config files, but the path is user-defined.
testMode?boolean(Optional) Set to true when invoking API Extractor's test harness.
tsdocMetadata?IConfigTsdocMetadata(BETA) (Optional) Configures how the tsdoc-metadata.json file will be generated.