@loopback/docs/site/apidocs/tsdocs.extractoroptions.md

Documentation files rendered at [https://loopback.io](https://loopback.io)

---
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) &gt; [@loopback/tsdocs](./tsdocs.md) &gt; [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

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[apiReportEnabled?](./tsdocs.extractoroptions.apireportenabled.md)


</td><td markdown="1">


</td><td markdown="1">

boolean


</td><td markdown="1">

_(Optional)_ A flag to control if `apiReport` should be enabled


</td></tr>
<tr><td markdown="1">

[config?](./tsdocs.extractoroptions.config.md)


</td><td markdown="1">


</td><td markdown="1">

IConfigFile


</td><td markdown="1">

_(Optional)_ Configuration for api-extractor


</td></tr>
<tr><td markdown="1">

[ignoreErrors?](./tsdocs.extractoroptions.ignoreerrors.md)


</td><td markdown="1">


</td><td markdown="1">

boolean


</td><td markdown="1">

_(Optional)_ A flag to control if errors should be ignored


</td></tr>
<tr><td markdown="1">

[mainEntryPointFilePath?](./tsdocs.extractoroptions.mainentrypointfilepath.md)


</td><td markdown="1">


</td><td markdown="1">

string


</td><td markdown="1">

_(Optional)_ mainEntryPointFilePath


</td></tr>
<tr><td markdown="1">

[tsconfigFilePath?](./tsdocs.extractoroptions.tsconfigfilepath.md)


</td><td markdown="1">


</td><td markdown="1">

string


</td><td markdown="1">

_(Optional)_ Path for tsconfig


</td></tr>
<tr><td markdown="1">

[typescriptCompilerFolder?](./tsdocs.extractoroptions.typescriptcompilerfolder.md)


</td><td markdown="1">


</td><td markdown="1">

string


</td><td markdown="1">

_(Optional)_ Custom TypeScript compiler dir


</td></tr>
</tbody></table>