UNPKG

@loopback/docs

Version:
34 lines (23 loc) 1.3 kB
--- lang: en title: 'API docs: tsdocs.extractoroptions' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar 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) | <code>boolean</code> | A flag to control if <code>apiReport</code> should be enabled | | [config](./tsdocs.extractoroptions.config.md) | <code>IConfigFile</code> | Configuration for api-extractor | | [mainEntryPointFilePath](./tsdocs.extractoroptions.mainentrypointfilepath.md) | <code>string</code> | mainEntryPointFilePath | | [tsconfigFilePath](./tsdocs.extractoroptions.tsconfigfilepath.md) | <code>string</code> | Path for tsconfig | | [typescriptCompilerFolder](./tsdocs.extractoroptions.typescriptcompilerfolder.md) | <code>string</code> | Custom TypeScript compiler dir |