TypeDoc API - v0.28.2

    Interface InlineTagDisplayPart

    Represents an inline tag like {@link Foo}

    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: "inline-tag"
    tag: `@${string}`
    text: string
    tsLinkText?: string
    MMNEPVFCICPMFPCPTTAAATR