Page Contents

Home > @loopback/tsdocs > ApiDocsOptions

ApiDocsOptions interface

Options for api docs

Signature:

export interface ApiDocsOptions 

Properties

Property Type Description
apiDocsExtractionPath string Path to tsdocs reports/models
apiDocsGenerationPath string Path to target directory to generate apidocs
dryRun boolean To have a dry-run without generating api reports/doc models
generateDefaultPackageDoc boolean A flag to generate default package documentation
rootDir string Root directory for the lerna-managed monorepo, default to current dir
silent boolean If true, do not print messages to console