mdast2docx logo Md2Docx
Version 0.2.4API DocsInterfaces

ImageReference

Updated 5 min ago

Defined in: packages/mdast/src/index.ts:843

Markdown image reference.

Extends

Properties

alt?

optional alt?: string | null

Defined in: packages/mdast/src/index.ts:94

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

Inherited from

Alternative.alt

data?

optional data?: ImageReferenceData

Defined in: packages/mdast/src/index.ts:851

Data associated with the mdast image reference.

Overrides

Node.data

identifier

identifier: string

Defined in: packages/mdast/src/index.ts:120

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.

Inherited from

Reference.identifier

label?

optional label?: string | null

Defined in: packages/mdast/src/index.ts:131

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.

Inherited from

Reference.label

position?

optional position?: Position

Defined in: node_modules/.pnpm/@types+unist@3.0.3/node_modules/@types/unist/index.d.ts:103

Position of a node in a source document.

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

Inherited from

Node.position

referenceType

referenceType: ReferenceType

Defined in: packages/mdast/src/index.ts:141

Explicitness of the reference.

Inherited from

Reference.referenceType

type

type: "imageReference"

Defined in: packages/mdast/src/index.ts:847

Node type of mdast image reference.

Overrides

Node.type

On this page