Page Contents
Home > @loopback/tsdocs > ApiDocsOptions
ApiDocsOptions interface
Options for api docs
Signature:
export interface ApiDocsOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [apiDocsExtractionPath?](/doc/en/lb4/apidocs.tsdocs.apidocsoptions.apidocsextractionpath.html) | string | _(Optional)_ Path to tsdocs reports/models | |
| [apiDocsGenerationPath?](/doc/en/lb4/apidocs.tsdocs.apidocsoptions.apidocsgenerationpath.html) | string | _(Optional)_ Path to target directory to generate apidocs | |
| [dryRun?](/doc/en/lb4/apidocs.tsdocs.apidocsoptions.dryrun.html) | boolean | _(Optional)_ To have a dry-run without generating api reports/doc models | |
| [generateDefaultPackageDoc?](/doc/en/lb4/apidocs.tsdocs.apidocsoptions.generatedefaultpackagedoc.html) | boolean | _(Optional)_ A flag to generate default package documentation | |
| [lernaPackages?](/doc/en/lb4/apidocs.tsdocs.apidocsoptions.lernapackages.html) | Record<string, [LernaPackage](/doc/en/lb4/apidocs.tsdocs.lernapackage.html)> | _(Optional)_ Package metadata | |
| [rootDir?](/doc/en/lb4/apidocs.tsdocs.apidocsoptions.rootdir.html) | string | _(Optional)_ Root directory for the lerna-managed monorepo, default to current dir | |
| [silent?](/doc/en/lb4/apidocs.tsdocs.apidocsoptions.silent.html) | boolean | _(Optional)_ If `true`, do not print messages to console |