UNPKG

@loopback/docs

Version:
36 lines (25 loc) 1.44 kB
--- lang: en title: 'API docs: tsdocs.extractoroptions' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar editurl: https://github.com/strongloop/loopback-next/tree/master/packages/tsdocs permalink: /doc/en/lb4/apidocs.tsdocs.extractoroptions.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/tsdocs](./tsdocs.md) &gt; [ExtractorOptions](./tsdocs.extractoroptions.md) ## ExtractorOptions interface Options to run api-extractor against the lerna repo <b>Signature:</b> ```typescript export interface ExtractorOptions extends ApiDocsOptions ``` ## Properties | Property | Type | Description | | --- | --- | --- | | [apiReportEnabled](./tsdocs.extractoroptions.apireportenabled.md) | boolean | A flag to control if <code>apiReport</code> should be enabled | | [config](./tsdocs.extractoroptions.config.md) | IConfigFile | Configuration for api-extractor | | [ignoreErrors](./tsdocs.extractoroptions.ignoreerrors.md) | boolean | A flag to control if errors should be ignored | | [mainEntryPointFilePath](./tsdocs.extractoroptions.mainentrypointfilepath.md) | string | mainEntryPointFilePath | | [tsconfigFilePath](./tsdocs.extractoroptions.tsconfigfilepath.md) | string | Path for tsconfig | | [typescriptCompilerFolder](./tsdocs.extractoroptions.typescriptcompilerfolder.md) | string | Custom TypeScript compiler dir |