Page Contents

Home > @loopback/tsdocs > ExtractorOptions

ExtractorOptions interface

Options to run api-extractor against the lerna repo

Signature:

export interface ExtractorOptions extends ApiDocsOptions 

Extends: ApiDocsOptions

Properties

Property Type Description
apiReportEnabled? boolean (Optional) A flag to control if apiReport should be enabled
config? IConfigFile (Optional) Configuration for api-extractor
ignoreErrors? boolean (Optional) A flag to control if errors should be ignored
mainEntryPointFilePath? string (Optional) mainEntryPointFilePath
tsconfigFilePath? string (Optional) Path for tsconfig
typescriptCompilerFolder? string (Optional) Custom TypeScript compiler dir