Home > @microsoft/api-documenter > MarkdownDocumenterAccessor > getLinkForApiItem
MarkdownDocumenterAccessor.getLinkForApiItem() method
For a given ApiItem, return its markdown hyperlink.
Signature:
getLinkForApiItem(apiItem: ApiItem): string | undefined;
Parameters
| Parameter | Type | Description |
|---|---|---|
| apiItem | ApiItem |
Returns:
string | undefined
The hyperlink, or undefined if the ApiItem object does not have a hyperlink.