Interface InlineTagDisplayPart

The @link, @linkcode, and @linkplain tags may have a target property set indicating which reflection/url they link to. They may also have a tsLinkText property which includes the part of the text which TypeScript thinks should be displayed as the link text.

interface InlineTagDisplayPart {
    kind: "inline-tag";
    tag: `@${string}`;
    text: string;
    target?: string | Models.Reflection | Models.ReflectionSymbolId;
    tsLinkText?: string;
}

Index

Properties

kind tag text target? tsLinkText?

Properties

kind

kind: "inline-tag"

tag

tag: `@${string}`

text

text: string

`Optional` target

target?: string | Models.Reflection | Models.ReflectionSymbolId

`Optional` tsLinkText

tsLinkText?: string