Interface InlineTagDisplayPart

If target is a number, it is a reflection ID. If a string, it is a URL. target will only be set for @link, @linkcode, and @linkplain tags.

interface InlineTagDisplayPart {
    kind: "inline-tag";
    tag: `@${string}`;
    text: string;
    target?: string | number | JSONOutput.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 | number | JSONOutput.ReflectionSymbolId

`Optional` tsLinkText

tsLinkText?: string