Interface Definition

Markdown definition.

interface Definition {
    data?: DefinitionData;
    identifier: string;
    label?: null | string;
    position?: "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Position;
    title?: null | string;
    type: "definition";
    url: string;
}

Hierarchy (view full)

Properties

data? identifier label? position? title? type url

Properties

Optional data

data?: DefinitionData

Data associated with the mdast definition.

identifier

identifier: string

Relation of association.

identifier is a source value: character escapes and character references are not parsed.

It can match another node.

Its value must be normalized. To normalize a value, collapse markdown whitespace ([\t\n\r ]+) to a space, trim the optional initial and/or final space, and perform Unicode-aware case-folding.

Optional label

label?: null | string

Relation of association, in parsed form.

label is a string value: it works just like title on Link or a lang on Code: character escapes and character references are parsed.

It can match another node.

Optional position

position?: "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Position

Position of a node in a source document.

Nodes that are generated (not in the original source document) must not have a position.

Optional title

title?: null | string

Advisory information for the resource, such as would be appropriate for a tooltip.

type

type: "definition"

Node type of mdast definition.

url

url: string

URL to the referenced resource.

Settings

Member Visibility

Theme

On This Page

dataidentifierlabelpositiontitletypeurl