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 |
|---|---|
|
Get workspace packages and sorted them by location | |
|
Get an array of lerna-managed TypeScript packages to generate tsdocs | |
|
Get un-scoped package name | |
|
Run api-extractor for a lerna-managed monrepo | |
|
Check if a package should be processed for tsdocs | |
|
Update markdown files generated by api-documenter to prepend Jekyll metadata and generate |
Interfaces
| Interface | Description |
|---|---|
|
Options for api docs | |
|
Options to run api-extractor against the lerna repo | |
|
Typescript definition for Lerna Package |
Variables
| Variable | Description |
|---|---|
|
Default path as the output directory for extracted api reports and models | |
|
Default path for apidocs to be generated for loopback.io site | |
|
Export the TypeScript path from |