Home > @microsoft/api-extractor > ExtractorResult > succeeded

ExtractorResult.succeeded property

Whether the invocation of API Extractor was successful. For example, if succeeded is false, then the build task would normally return a nonzero process exit code, indicating that the operation failed.

Signature:

readonly succeeded: boolean;

Remarks

Normally the operation "succeeds" if errorCount and warningCount are both zero. However if IExtractorInvokeOptions.localBuild is true, then the operation "succeeds" if errorCount is zero (i.e. warnings are ignored).