Page Contents
tsdocs package
The @loopback/tsdocs package is an internal module to generate tsdoc based API docs for @loopback/* packages within loopback-next monorepo managed by Lerna.
Remarks
It’s built on top of Microsoft API Extractor:
Functions
| Function | Description |
|---|---|
| [getPackages(rootDir)](/doc/en/lb4/apidocs.tsdocs.getpackages.html) | Get workspace packages and sorted them by location |
| [getPackagesWithTsDocs(rootDir)](/doc/en/lb4/apidocs.tsdocs.getpackageswithtsdocs.html) | Get an array of lerna-managed TypeScript packages to generate tsdocs |
| [getUnscopedPackageName(name)](/doc/en/lb4/apidocs.tsdocs.getunscopedpackagename.html) | Get un-scoped package name |
| [runExtractorForMonorepo(options)](/doc/en/lb4/apidocs.tsdocs.runextractorformonorepo.html) | Run api-extractor for a lerna-managed monrepo |
| [runExtractorForPackage(pkgDir, options)](/doc/en/lb4/apidocs.tsdocs.runextractorforpackage.html) | |
| [shouldGenerateTsDocs(pkg)](/doc/en/lb4/apidocs.tsdocs.shouldgeneratetsdocs.html) | Check if a package should be processed for tsdocs |
| [updateApiDocs(options)](/doc/en/lb4/apidocs.tsdocs.updateapidocs.html) | Update markdown files generated by api-documenter to prepend Jekyll metadata and generate `apidocs/index.md`. |
Interfaces
| Interface | Description |
|---|---|
| [ApiDocsOptions](/doc/en/lb4/apidocs.tsdocs.apidocsoptions.html) | Options for api docs |
| [ExtractorOptions](/doc/en/lb4/apidocs.tsdocs.extractoroptions.html) | Options to run api-extractor against the lerna repo |
| [LernaPackage](/doc/en/lb4/apidocs.tsdocs.lernapackage.html) | Typescript definition for [Lerna Package](https://github.com/lerna/lerna/blob/master/core/package/index.js) |
Variables
| Variable | Description |
|---|---|
| [DEFAULT\_APIDOCS\_EXTRACTION\_PATH](/doc/en/lb4/apidocs.tsdocs.default_apidocs_extraction_path.html) | Default path as the output directory for extracted api reports and models |
| [DEFAULT\_APIDOCS\_GENERATION\_PATH](/doc/en/lb4/apidocs.tsdocs.default_apidocs_generation_path.html) | Default path for apidocs to be generated for loopback.io site |
| [typeScriptPath](/doc/en/lb4/apidocs.tsdocs.typescriptpath.html) | Export the TypeScript path from `@loopback/build` |