unified

Project: syntax-tree/mdast-util-assert

Package: mdast-util-assert@4.0.0

  1. Dependencies: 4·Dependents: 4
  2. mdast utility to assert trees
  1. util 136
  2. utility 132
  3. unist 119
  4. mdast 88
  5. mdast-util 29
  6. check 11
  7. test 6
  8. assert 4

mdast-util-assert

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to assert trees.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install mdast-util-assert

Use

import {assert} from 'mdast-util-assert'

assert({type: 'root', children: []})
assert({type: 'break'})
assert({type: 'listItem', checked: true, children: []})
// All OK.

assert({children: []})
// AssertionError: node should have a type: `{ children: [] }`

assert({type: 'paragraph', value: 'foo'})
// AssertionError: parent should have children: `{ type: 'paragraph', value: 'foo' }`

API

This package exports the following identifiers: assert, parent, literal, _void, wrap. There is no default export.

assert(node)

Assert that tree is a valid mdast node. If tree is a parent, all children will be asserted as well.

The parent, literal, _void, and wrap methods from unist-util-assert are also included.

Security

Use of mdast-util-assert does not involve hast so there are no openings for cross-site scripting (XSS) attacks.

Contribute

See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer