Page Contents

Home > @loopback/tsdocs > ApiDocsOptions

ApiDocsOptions interface

Options for api docs


export interface ApiDocsOptions 


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