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";
    target: undefined | number;
    text: string;
}

Properties

target: undefined | number

A link to either some document outside of the project or a reflection. This may be undefined if the relative path does not exist.

text: string

The original relative text from the parsed comment.