mdast-util-visit

mdast-util-visit

mdast utility to recursively walk over nodes: both forwards and backwards.

Installation

npm:

npm install mdast-util-visit

mdast-util-visit is also available for bower, component, and duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

/*
 * Dependencies.
 */

var mdast = require('mdast');
var visit = require('mdast-util-visit');

/*
 * AST.
 */

var ast = mdast.parse('Some *emphasis*, **strongness**, and `code`.');

visit(ast, 'text', console.log.bind(console));
/*
 * {type: 'text', 'value': 'Some '}
 * {type: 'text', 'value': 'emphasis'}
 * {type: 'text', 'value': ', '}
 * {type: 'text', 'value': 'strongness'}
 * {type: 'text', 'value': ', and '}
 * {type: 'text', 'value': '.'}
 */

API

visit(ast[, type], callback[, reverse])

Visit nodes. Optionally by node type, Optionally in reverse.

• ast (Node) — mdast node;

• type (string, optional) — Optional node type to invoke callback for. By default, all nodes are visited.

• callback (function(node, index?, parent?)) — Callback when a node (matching type) is found. Invoked with the node, its index in parent (or null), and its parent (or null).

  Can return false to stop checking.

• reverse (boolean, default: false, optional) — When falsey, checking starts at the first child and continues through to later children. When truthy, this is reversed.

  This does not mean checking starts at the deepest node and continues on to the highest node.

License

MIT © Titus Wormer