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

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

---
lang: en
title: 'API docs: tsdocs.apidocsoptions'
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.apidocsoptions.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/tsdocs](./tsdocs.md) &gt; [ApiDocsOptions](./tsdocs.apidocsoptions.md)

## ApiDocsOptions interface

Options for api docs

**Signature:**

```typescript
export interface ApiDocsOptions 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[apiDocsExtractionPath?](./tsdocs.apidocsoptions.apidocsextractionpath.md)


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


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

string


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

_(Optional)_ Path to tsdocs reports/models


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

[apiDocsGenerationPath?](./tsdocs.apidocsoptions.apidocsgenerationpath.md)


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


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

string


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

_(Optional)_ Path to target directory to generate apidocs


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

[dryRun?](./tsdocs.apidocsoptions.dryrun.md)


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


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

boolean


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

_(Optional)_ To have a dry-run without generating api reports/doc models


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

[generateDefaultPackageDoc?](./tsdocs.apidocsoptions.generatedefaultpackagedoc.md)


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


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

boolean


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

_(Optional)_ A flag to generate default package documentation


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

[lernaPackages?](./tsdocs.apidocsoptions.lernapackages.md)


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


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

Record&lt;string, [LernaPackage](./tsdocs.lernapackage.md)<!-- -->&gt;


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

_(Optional)_ Package metadata


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

[rootDir?](./tsdocs.apidocsoptions.rootdir.md)


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


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

string


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

_(Optional)_ Root directory for the lerna-managed monorepo, default to current dir


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

[silent?](./tsdocs.apidocsoptions.silent.md)


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


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

boolean


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

_(Optional)_ If `true`<!-- -->, do not print messages to console


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