ListItem

Example: Usage

import type { ListItem } from "@ende/markdown/types";
import { assertEquals } from "@ende/assert";

const node: ListItem = { type: "listItem", spread: false, checked: null, children: [] };
assertEquals(node.checked, null);

Example: A task list item

import type { ListItem } from "@ende/markdown/types";
import { assertEquals } from "@ende/assert";

// `- [x] Done` with the `gfm` option:
const node: ListItem = {
  type: "listItem",
  spread: false,
  checked: true,
  children: [{ type: "paragraph", children: [{ type: "text", value: "Done" }] }]
};
assertEquals(node.checked, true);

type

type: "listItem"

Node type.

spread

spread: boolean

Whether a blank line separates any of the item's direct children.

checked

checked: boolean | null

Whether a task list item is checked ([x]) or not ([ ]), or null if the item isn't a task. Only the gfm option parses task list items; the marker is removed from the item's first paragraph.

children

children: (BlockContent | DefinitionContent)[]

The blocks in the item.