mdast2docx logo Md2Docx
Version 1.8.1API DocsInterfaces

List

Updated 22 Oct 2026

Defined in: node_modules/.pnpm/@types+mdast@4.0.4/node_modules/@types/mdast/index.d.ts:851

Markdown list.

Extends

Properties

children

children: ListItem[]

Defined in: node_modules/.pnpm/@types+mdast@4.0.4/node_modules/@types/mdast/index.d.ts:873

Children of list.

Overrides

Parent.children

data?

optional data?: ListData

Defined in: node_modules/.pnpm/@types+mdast@4.0.4/node_modules/@types/mdast/index.d.ts:877

Data associated with the mdast list.

Overrides

Parent.data

ordered?

optional ordered?: boolean | null

Defined in: node_modules/.pnpm/@types+mdast@4.0.4/node_modules/@types/mdast/index.d.ts:860

Whether the items have been intentionally ordered (when true), or that the order of items is not important (when false or not present).

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

Parent.position

spread?

optional spread?: boolean | null

Defined in: node_modules/.pnpm/@types+mdast@4.0.4/node_modules/@types/mdast/index.d.ts:869

Whether one or more of the children are separated with a blank line from its siblings (when true), or not (when false or not present).

start?

optional start?: number | null

Defined in: node_modules/.pnpm/@types+mdast@4.0.4/node_modules/@types/mdast/index.d.ts:864

The starting number of the list, when the ordered field is true.

type

type: "list"

Defined in: node_modules/.pnpm/@types+mdast@4.0.4/node_modules/@types/mdast/index.d.ts:855

Node type of mdast list.

Overrides

Parent.type

On this page