Home > @microsoft/api-extractor > ExtractorConfig > getDiagnosticDump

ExtractorConfig.getDiagnosticDump() method

Returns a JSON-like string representing the ExtractorConfig state, which can be printed to a console for diagnostic purposes.

Signature:

getDiagnosticDump(): string;

Returns:

string

Remarks

This is used by the “–diagnostics” command-line option. The string is not intended to be deserialized; its format may be changed at any time.