@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
37 lines (26 loc) • 1.65 kB
Markdown
lang: en
title: 'API docs: tsdocs.extractoroptions'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/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) > [@loopback/tsdocs](./tsdocs.md) > [ExtractorOptions](./tsdocs.extractoroptions.md)
## ExtractorOptions interface
Options to run api-extractor against the lerna repo
**Signature:**
```typescript
export interface ExtractorOptions extends ApiDocsOptions
```
**Extends:** [ApiDocsOptions](./tsdocs.apidocsoptions.md)
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiReportEnabled?](./tsdocs.extractoroptions.apireportenabled.md) | | boolean | _(Optional)_ A flag to control if <code>apiReport</code> should be enabled |
| [config?](./tsdocs.extractoroptions.config.md) | | IConfigFile | _(Optional)_ Configuration for api-extractor |
| [ignoreErrors?](./tsdocs.extractoroptions.ignoreerrors.md) | | boolean | _(Optional)_ A flag to control if errors should be ignored |
| [mainEntryPointFilePath?](./tsdocs.extractoroptions.mainentrypointfilepath.md) | | string | _(Optional)_ mainEntryPointFilePath |
| [tsconfigFilePath?](./tsdocs.extractoroptions.tsconfigfilepath.md) | | string | _(Optional)_ Path for tsconfig |
| [typescriptCompilerFolder?](./tsdocs.extractoroptions.typescriptcompilerfolder.md) | | string | _(Optional)_ Custom TypeScript compiler dir |