Home > @microsoft/api-extractor > IExtractorConfigPrepareOptions

IExtractorConfigPrepareOptions interface

Options for ExtractorConfig.prepare().

Signature:

export interface IExtractorConfigPrepareOptions 

Properties

Property Type Description
configObject IConfigFile A configuration object as returned by ExtractorConfig.loadFile().
configObjectFullPath string | undefined The absolute path of the file that the configObject object was loaded from. This is used for error messages and when probing for tsconfig.json.
packageJson? INodePackageJson | undefined (Optional) The parsed package.json file for the working package, or undefined if API Extractor was invoked without a package.json file.
packageJsonFullPath string | undefined The absolute path of the file that the packageJson object was loaded from, or undefined if API Extractor was invoked without a package.json file.
projectFolderLookupToken? string (Optional) The default value for the projectFolder setting is the <lookup> token, which uses a heuristic to guess an appropriate project folder. Use projectFolderLookupValue to manually specify the <lookup> token value instead.