Interface RelativeLinkDisplayPart

This is used for relative links within comments/documents. It is used to mark pieces of text which need to be replaced to make links work properly.

interface RelativeLinkDisplayPart {
    kind: "relative-link";
    text: string;
    target?: number;
    targetAnchor?: string;
}

Properties

kind: "relative-link"

text: string

The original relative text from the parsed comment.

target?: number

File ID, if present

targetAnchor?: string

Anchor within the target file, if present