Home > @microsoft/api-extractor > ConsoleMessageId

ConsoleMessageId enum

Unique identifiers for console messages reported by API Extractor.

Signature:

export declare const enum ConsoleMessageId 

Enumeration Members

Member Value Description
ApiReportCopied "console-api-report-copied" “You have changed the public API signature for this project. Updating ___”
ApiReportCreated "console-api-report-created" “The API report file was missing, so a new file was created. Please add this file to Git: ___”
ApiReportFolderMissing "console-api-report-folder-missing" “Unable to create the API report file. Please make sure the target folder exists: ___”
ApiReportNotCopied "console-api-report-not-copied" “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 "console-api-report-unchanged" “The API report is up to date: ___”
Diagnostics "console-diagnostics" Used for the information printed when the “–diagnostics” flag is enabled.
FoundTSDocMetadata "console-found-tsdoc-metadata" “Found metadata in ___”
WritingDocModelFile "console-writing-doc-model-file" “Writing: ___”
WritingDtsRollup "console-writing-dts-rollup" “Writing package typings: ___”

Remarks

These strings are possible values for the ExtractorMessage.messageId property when the ExtractorMessage.category is ExtractorMessageCategory.Console.