Page Contents

Home > @loopback/tsdocs > runExtractorForMonorepo

runExtractorForMonorepo() function

Run api-extractor for a lerna-managed monrepo

Signature:

export declare function runExtractorForMonorepo(options?: ExtractorOptions): Promise<void>;

Parameters

Parameter Type Description
options ExtractorOptions (Optional) Options for running api-extractor

Returns:

Promise<void>

Remarks

The function performs the following steps: 1. Discover packages with tsdocs from the monorepo 2. Iterate through each package to run api-extractor