Rush StackShopBlogEvents
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.


apiReportChangedreadonlybooleanReturns true if the API report was found to have changed.
compilerStatereadonlyCompilerStateThe TypeScript compiler state that was used.
errorCountreadonlynumberReports the number of errors encountered during analysis.
extractorConfigreadonlyExtractorConfigThe API Extractor configuration that was used.
succeededreadonlybooleanWhether 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.
warningCountreadonlynumberReports the number of warnings encountered during analysis.