Home > @microsoft/api-extractor > ExtractorMessage > formatMessageWithLocation
ExtractorMessage.formatMessageWithLocation() method
Returns the message formatted with its identifier and file position.
Signature:
formatMessageWithLocation(workingPackageFolderPath: string | undefined): string;
Parameters
Parameter | Type | Description |
---|---|---|
workingPackageFolderPath | string | undefined |
Returns:
string
Remarks
Example:
src/folder/File.ts:123:4 - (ae-extra-release-tag) The doc comment should not contain more than one release tag.