Home > @microsoft/api-extractor > ConsoleMessageId
ConsoleMessageId enum
Unique identifiers for console messages reported by API Extractor.
Signature:
export declare enum ConsoleMessageId
Enumeration Members
Member | Value | Description |
|---|---|---|
ApiReportCopied |
| "You have changed the public API signature for this project. Updating ___" |
ApiReportCreated |
| "The API report file was missing, so a new file was created. Please add this file to Git: ___" |
ApiReportDiff |
| Changes to the API report: ___ |
ApiReportFolderMissing |
| "Unable to create the API report file. Please make sure the target folder exists: ___" |
ApiReportNotCopied |
| "You have changed the public API signature for this project. Please copy the file ___ to ___, or perform a local build (which does this automatically). See the Git repo documentation for more info." OR "The API report file is missing. Please copy the file ___ to ___, or perform a local build (which does this automatically). See the Git repo documentation for more info." |
ApiReportUnchanged |
| "The API report is up to date: ___" |
CompilerVersionNotice |
| "The target project appears to use TypeScript ___ which is newer than the bundled compiler engine; consider upgrading API Extractor." |
Diagnostics |
| Used for the information printed when the "--diagnostics" flag is enabled. |
FoundTSDocMetadata |
| "Found metadata in ___" |
Preamble |
| "Analysis will use the bundled TypeScript version ___" |
UsingCustomTSDocConfig |
| "Using custom TSDoc config from ___" |
WritingApiReport |
| "Generating ___ API report: ___" |
WritingDocModelFile |
| "Writing: ___" |
WritingDtsRollup |
| "Writing package typings: ___" |
Remarks
These strings are possible values for the ExtractorMessage.messageId property when the ExtractorMessage.category is ExtractorMessageCategory.Console.