README
unist-util-visit-children
unist utility to visit direct children of a parent.
Install
This package is ESM only:
Node 12+ is needed to use it and it must be import
ed instead of require
d.
npm:
npm install unist-util-visit-children
Use
import u from 'unist-builder'
import {visitChildren} from '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
This package exports the following identifiers: visitChildren
.
There is no default export.
visit = visitChildren(visitor)
Wrap visitor
to be called for each child in the nodes later
given to visit
.
function visitor(child, index, parent)
Called if visit
is called on a parent node for each child.
function visit(parent)
Called visitor
for each child of the parent.
Related
unist-util-visit
— Recursively walk over nodesunist-util-visit-parents
— Likevisit
, but with a stack of parentsunist-util-filter
— Create a new tree with all nodes that pass a testunist-util-map
— Create a new tree with all nodes mapped by a given functionunist-util-flatmap
— Create a new tree by mapping (to an array) with the given functionunist-util-find-all-after
— Find nodes after another nodeunist-util-find-all-before
— Find nodes before another nodeunist-util-find-after
— Find a node after another nodeunist-util-find-before
— Find a node before another nodeunist-util-find-all-between
— Find all nodes between two nodesunist-util-remove
— Remove nodes from a tree that pass a testunist-util-select
— Select nodes with CSS-like selectors
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.