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

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

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

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

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

## tsdocs package

The `@loopback/tsdocs` package is an internal module to generate [tsdoc](https://github.com/Microsoft/tsdoc) based API docs for `@loopback/*` packages within [loopback-next](https://github.com/loopbackio/loopback-next) monorepo managed by [Lerna](https://github.com/lerna/lerna)<!-- -->.

## Remarks

It's built on top of [Microsoft API Extractor](https://api-extractor.com)<!-- -->:

- [api-extractor](https://github.com/Microsoft/web-build-tools/tree/master/apps/api-extractor) - [api-documenter](https://github.com/Microsoft/web-build-tools/tree/master/apps/api-documenter)

## Functions

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

Function


</th><th>

Description


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

[getPackages(rootDir)](./tsdocs.getpackages.md)


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

Get workspace packages and sorted them by location


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

[getPackagesWithTsDocs(rootDir)](./tsdocs.getpackageswithtsdocs.md)


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

Get an array of lerna-managed TypeScript packages to generate tsdocs


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

[getUnscopedPackageName(name)](./tsdocs.getunscopedpackagename.md)


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

Get un-scoped package name


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

[runExtractorForMonorepo(options)](./tsdocs.runextractorformonorepo.md)


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

Run api-extractor for a lerna-managed monrepo


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

[runExtractorForPackage(pkgDir, options)](./tsdocs.runextractorforpackage.md)


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


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

[shouldGenerateTsDocs(pkg)](./tsdocs.shouldgeneratetsdocs.md)


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

Check if a package should be processed for tsdocs


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

[updateApiDocs(options)](./tsdocs.updateapidocs.md)


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

Update markdown files generated by api-documenter to prepend Jekyll metadata and generate `apidocs/index.md`<!-- -->.


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

## Interfaces

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

Interface


</th><th>

Description


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

[ApiDocsOptions](./tsdocs.apidocsoptions.md)


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

Options for api docs


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

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


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

Options to run api-extractor against the lerna repo


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

[LernaPackage](./tsdocs.lernapackage.md)


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

Typescript definition for [Lerna Package](https://github.com/lerna/lerna/blob/master/core/package/index.js)


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

## Variables

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

Variable


</th><th>

Description


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

[DEFAULT\_APIDOCS\_EXTRACTION\_PATH](./tsdocs.default_apidocs_extraction_path.md)


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

Default path as the output directory for extracted api reports and models


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

[DEFAULT\_APIDOCS\_GENERATION\_PATH](./tsdocs.default_apidocs_generation_path.md)


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

Default path for apidocs to be generated for loopback.io site


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

[typeScriptPath](./tsdocs.typescriptpath.md)


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

Export the TypeScript path from `@loopback/build`


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