Interface ImageReference

Markdown image reference.

interface ImageReference {
    alt?: null | string;
    data?: ImageReferenceData;
    identifier: string;
    label?: null | string;
    position?: "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Position;
    referenceType: ReferenceType;
    type: "imageReference";
}

Hierarchy (view full)

Properties

alt? data? identifier label? position? referenceType type

Properties

Optional alt

alt?: null | string

Equivalent content for environments that cannot represent the node as intended.

Optional data

data?: ImageReferenceData

Data associated with the mdast image reference.

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.

referenceType

referenceType: ReferenceType

Explicitness of the reference.

type

type: "imageReference"

Node type of mdast image reference.

Settings

Member Visibility

Theme

On This Page

altdataidentifierlabelpositionreferenceTypetype