gibson042 / unist-util-visit

Utility to recursively walk over Unist nodes

unist-util-visit

Unist node visitor. Useful when working with remark, retext, or rehype.

Installation

npm:

npm install unist-util-visit

Usage

var remark = require('remark');
var visit = require('unist-util-visit');

var tree = remark.parse('Some _emphasis_, **importance**, and `code`.');

visit(tree, 'text', visitor);

function visitor(node) {
  console.log(node);
}

Yields:

{ type: 'text', value: 'Some ' }
{ type: 'text', value: 'emphasis' }
{ type: 'text', value: ', ' }
{ type: 'text', value: 'importance' }
{ type: 'text', value: ', and ' }
{ type: 'text', value: '.' }

API

visit(node[, type], visitor[, reverse])

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

Parameters

• node (Node) — Node to search
• type (string, optional) — Node type
• visitor (Function) — Visitor invoked when a node is found
• reverse (boolean, default: false) — 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

stop? = visitor(node, index, parent)

Invoked when a node (when type is given, matching type) is found.

Parameters

• node (Node) — Found node
• index (number?) — Position of node in parent
• parent (Node?) — Parent of node

Returns

boolean? - When false, visiting is immediately stopped.

Related

• unist-util-visit-parents — Like visit, but with a stack of parents
• unist-util-filter — Create a new tree with all nodes that pass a test
• unist-util-map — Create a new tree with all nodes mapped by a given function
• unist-util-remove — Remove nodes from a tree that pass a test
• unist-util-select — Select nodes with CSS-like selectors

License

MIT © Titus Wormer