mdast2docx logo Md2Docx
Version 1.8.1API DocsInterfaces

SVGData

Updated 22 Oct 2026

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

Info associated with mdast nodes by the ecosystem.

This space is guaranteed to never be specified by unist or mdast. But you can use it in utilities and plugins to store data.

This type can be augmented to register custom data. For example:

declare module 'mdast' {
  interface Data {
    // `someNode.data.myId` is typed as `number | undefined`
    myId?: number | undefined
  }
}

Extends

Properties

alignment?

optional alignment?: "left" | "right" | "start" | "center" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

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

Inherited from

Data.alignment

allCaps?

optional allCaps?: boolean

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

Inherited from

Data.allCaps

altText?

optional altText?: DocPropertiesOptions | \{ description?: string; name?: string; title?: string; \}

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

Inherited from

Data.altText

bold?

optional bold?: boolean

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

Inherited from

Data.bold

border?

optional border?: Mutable<IBordersOptions | IBorderOptions>

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

Inherited from

Data.border

checked?

optional checked?: boolean

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

Inherited from

Data.checked

color?

optional color?: string

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

Inherited from

Data.color

emphasisMark?

optional emphasisMark?: Record<string, never>

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

Inherited from

Data.emphasisMark

frame?

optional frame?: IFrameOptions

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

Inherited from

Data.frame

hChildren?

optional hChildren?: ElementContent[]

Defined in: node_modules/.pnpm/mdast-util-to-hast@13.2.1/node_modules/mdast-util-to-hast/index.d.ts:74

Field supported by mdast-util-to-hast to signal that a node should result in something with these children.

When this is defined, when a parent is created, these children will be used.

Inherited from

Data.hChildren

height?

optional height?: number

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

Inherited from

Data.height

highlight?

optional highlight?: string

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

Inherited from

Data.highlight

hName?

optional hName?: string

Defined in: node_modules/.pnpm/mdast-util-to-hast@13.2.1/node_modules/mdast-util-to-hast/index.d.ts:83

Field supported by mdast-util-to-hast to signal that a node should result in a particular element, instead of its default behavior.

When this is defined, an element with the given tag name is created. For example, when setting hName to 'b', a <b> element is created.

Inherited from

Data.hName

hProperties?

optional hProperties?: Properties

Defined in: node_modules/.pnpm/mdast-util-to-hast@13.2.1/node_modules/mdast-util-to-hast/index.d.ts:92

Field supported by mdast-util-to-hast to signal that a node should result in an element with these properties.

When this is defined, when an element is created, these properties will be used.

Inherited from

Data.hProperties

italics?

optional italics?: boolean

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

Inherited from

Data.italics

mermaid?

optional mermaid?: string

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

Mermaid source code

name?

optional name?: string

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

Inherited from

Data.name

pre?

optional pre?: boolean

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

Inherited from

Data.pre

smallCaps?

optional smallCaps?: boolean

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

Inherited from

Data.smallCaps

strike?

optional strike?: boolean

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

Inherited from

Data.strike

style?

optional style?: string

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

Inherited from

Data.style

subScript?

optional subScript?: boolean

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

Inherited from

Data.subScript

superScript?

optional superScript?: boolean

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

Inherited from

Data.superScript

tag?

optional tag?: "symbol" | "object" | "title" | "text" | "style" | "map" | "filter" | "blockquote" | "code" | "html" | "image" | "link" | "strong" | "table" | "svg" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "search" | "section" | "select" | "slot" | "small" | "source" | "span" | "sub" | "summary" | "sup" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "animate" | "animateMotion" | "animateTransform" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "foreignObject" | "g" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "set" | "stop" | "switch" | "textPath" | "tspan" | "use" | "view"

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

Inherited from

Data.tag

type?

optional type?: string

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

Inherited from

Data.type

underline?

optional underline?: \{ color: string; type: "single" | "words" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "none"; \} | Record<string, never>

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

Inherited from

Data.underline

value?

optional value?: string

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

Inherited from

Data.value

width?

optional width?: number

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

Inherited from

Data.width

SVG

Previous Page

Table

Next Page

On this page

ExtendsPropertiesalignment?Inherited fromallCaps?Inherited fromaltText?Inherited frombold?Inherited fromborder?Inherited fromchecked?Inherited fromcolor?Inherited fromemphasisMark?Inherited fromframe?Inherited fromhChildren?Inherited fromheight?Inherited fromhighlight?Inherited fromhName?Inherited fromhProperties?Inherited fromitalics?Inherited frommermaid?name?Inherited frompre?Inherited fromsmallCaps?Inherited fromstrike?Inherited fromstyle?Inherited fromsubScript?Inherited fromsuperScript?Inherited fromtag?Inherited fromtype?Inherited fromunderline?Inherited fromvalue?Inherited fromwidth?Inherited from