Home > @microsoft/api-extractor > IExtractorInvokeOptions > localBuild

IExtractorInvokeOptions.localBuild property

Indicates that API Extractor is running as part of a local build, e.g. on developer’s machine.

Signature:

localBuild?: boolean;

Remarks

This disables certain validation that would normally be performed for a ship/production build. For example, the *.api.md report file is automatically updated in a local build.

The default value is false.