Page Contents
Home > @loopback/tsdocs > ExtractorOptions
ExtractorOptions interface
Options to run api-extractor against the lerna repo
Signature:
export interface ExtractorOptions extends ApiDocsOptions
Extends: ApiDocsOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [apiReportEnabled?](/doc/en/lb4/apidocs.tsdocs.extractoroptions.apireportenabled.html) | boolean | _(Optional)_ A flag to control if `apiReport` should be enabled | |
| [config?](/doc/en/lb4/apidocs.tsdocs.extractoroptions.config.html) | IConfigFile | _(Optional)_ Configuration for api-extractor | |
| [ignoreErrors?](/doc/en/lb4/apidocs.tsdocs.extractoroptions.ignoreerrors.html) | boolean | _(Optional)_ A flag to control if errors should be ignored | |
| [mainEntryPointFilePath?](/doc/en/lb4/apidocs.tsdocs.extractoroptions.mainentrypointfilepath.html) | string | _(Optional)_ mainEntryPointFilePath | |
| [tsconfigFilePath?](/doc/en/lb4/apidocs.tsdocs.extractoroptions.tsconfigfilepath.html) | string | _(Optional)_ Path for tsconfig | |
| [typescriptCompilerFolder?](/doc/en/lb4/apidocs.tsdocs.extractoroptions.typescriptcompilerfolder.html) | string | _(Optional)_ Custom TypeScript compiler dir |