mdast2docx logo Md2Docx
Version 1.8.0API DocsInterfaces

Checkbox

Updated 5 min ago

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

Abstract mdast node.

This interface is supposed to be extended. If you can use Literal or Parent, you should. But for example in markdown, a thematic break (***) is neither literal nor parent, but still a node.

To register custom mdast nodes, add them to RootContentMap and other places where relevant (such as ElementContentMap).

For a union of all registered mdast nodes, see Nodes.

Extends

Properties

checked?

optional checked?: boolean

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

data?

optional data?: Data

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

Info from the ecosystem.

Inherited from

Node.data

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

type

type: "checkbox"

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

Node type.

Overrides

Node.type

On this page