@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

<b>Signature:</b>

```typescript
export interface ApiDocsOptions 
```

## Properties

|  Property | Type | Description |
|  --- | --- | --- |
|  [apiDocsExtractionPath?](./tsdocs.apidocsoptions.apidocsextractionpath.md) | string | <i>(Optional)</i> Path to tsdocs reports/models |
|  [apiDocsGenerationPath?](./tsdocs.apidocsoptions.apidocsgenerationpath.md) | string | <i>(Optional)</i> Path to target directory to generate apidocs |
|  [dryRun?](./tsdocs.apidocsoptions.dryrun.md) | boolean | <i>(Optional)</i> To have a dry-run without generating api reports/doc models |
|  [generateDefaultPackageDoc?](./tsdocs.apidocsoptions.generatedefaultpackagedoc.md) | boolean | <i>(Optional)</i> A flag to generate default package documentation |
|  [lernaPackages?](./tsdocs.apidocsoptions.lernapackages.md) | Record&lt;string, [LernaPackage](./tsdocs.lernapackage.md)<!-- -->&gt; | <i>(Optional)</i> Package metadata |
|  [rootDir?](./tsdocs.apidocsoptions.rootdir.md) | string | <i>(Optional)</i> Root directory for the lerna-managed monorepo, default to current dir |
|  [silent?](./tsdocs.apidocsoptions.silent.md) | boolean | <i>(Optional)</i> If <code>true</code>, do not print messages to console |