unified

Project:syntax-tree/unist-util-visit-children

Package:unist-util-visit-children@1.1.3

  1. Dependencies:0·Dependents:8
  2. Unist utility to visit direct children of a parent
  1. util 51
  2. utility 48
  3. unist 36
  4. visit 3
  5. children 2

unist-util-visit-children

Build Coverage Downloads Size

unist direct child visitor.

Install

npm:

npm install unist-util-visit-children

Usage

var u = require('unist-builder')
var visitChildren = require('unist-util-visit-children')

var visit = visitChildren(function(node) {
  console.log(node)
})

var tree = u('tree', [
  u('leaf', 'leaf 1'),
  u('node', [u('leaf', 'leaf 2'), u('leaf', 'leaf 3')]),
  u('leaf', 'leaf 4'),
  u('void')
])

visit(tree)

Yields:

{ type: 'leaf', value: 'leaf 1' }
{
  type: 'node',
  children: [
    { type: 'leaf', value: 'leaf 2' },
    { type: 'leaf', value: 'leaf 3' }
  ]
}
{ type: 'leaf', value: 'leaf 4' }
{ type: 'void' }

API

visit = visitChildren(visitor)

Wrap visitor to be invoked for each child in the nodes later given to visit.

function visitor(child, index, parent)

Invoked if visit is called on a parent node for each child.

function visit(parent)

Invoke visitor for each child of the parent.

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer