Home > @microsoft/api-extractor > ExtractorResult

ExtractorResult class

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

Signature:

export declare class ExtractorResult 

Remarks

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.

Properties

Property Modifiers Type Description
apiReportChanged   boolean Returns true if the API report was found to have changed.
compilerState   CompilerState The TypeScript compiler state that was used.
errorCount   number Reports the number of errors encountered during analysis.
extractorConfig   ExtractorConfig The API Extractor configuration that was used.
succeeded   boolean 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.
warningCount   number Reports the number of warnings encountered during analysis.