mdast-util-assert

mdast utility to assert trees


Keywords
unist, mdast, mdast-util, util, utility, assert, check, test, markdown, syntax-tree
License
MIT
Install
npm install mdast-util-assert@3.0.0

Documentation

mdast-util-assert

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to assert trees.

Install

npm:

npm install mdast-util-assert

Use

var assert = require('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

assert(node)

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

The assert.parent, assert.text, assert.void, and assert.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