Home > @microsoft/api-extractor-model > ReleaseTag > getTagName

ReleaseTag.getTagName() function

Returns the TSDoc tag name for a ReleaseTag value.

Signature:

function getTagName(releaseTag: ReleaseTag): string;

Parameters

Parameter Type Description
releaseTag ReleaseTag  

Returns:

string

Remarks

For example, getTagName(ReleaseTag.Internal) would return the string @internal.