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

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

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

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

[Home](./index.md) &gt; [@loopback/tsdocs](./tsdocs.md) &gt; [runExtractorForMonorepo](./tsdocs.runextractorformonorepo.md)

## runExtractorForMonorepo() function

Run api-extractor for a lerna-managed monrepo

**Signature:**

```typescript
export declare function runExtractorForMonorepo(options?: ExtractorOptions): Promise<void>;
```

## Parameters

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

Parameter


</th><th>

Type


</th><th>

Description


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

options


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

[ExtractorOptions](./tsdocs.extractoroptions.md)


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

_(Optional)_ Options for running api-extractor


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

**Returns:**

Promise&lt;void&gt;

## Remarks

The function performs the following steps: 1. Discover packages with tsdocs from the monorepo 2. Iterate through each package to run `api-extractor`