Skip to main content

Home > @microsoft/api-extractor > ExtractorResult

ExtractorResult class

This object represents the outcome of an invocation of API Extractor.

export declare class ExtractorResult


The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ExtractorResult class.


apiReportChangedbooleanReturns true if the API report was found to have changed.
compilerStateCompilerStateThe TypeScript compiler state that was used.
errorCountnumberReports the number of errors encountered during analysis.
extractorConfigExtractorConfigThe API Extractor configuration that was used.
succeededbooleanWhether 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.
warningCountnumberReports the number of warnings encountered during analysis.