Package Exports

unist-util-visit-children

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (unist-util-visit-children) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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 imported instead of required.

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.

unist-util-visit — Recursively walk over nodes
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-flatmap — Create a new tree by mapping (to an array) with the given function
unist-util-find-all-after — Find nodes after another node
unist-util-find-all-before — Find nodes before another node
unist-util-find-after — Find a node after another node
unist-util-find-before — Find a node before another node
unist-util-find-all-between — Find all nodes between two nodes
unist-util-remove — Remove nodes from a tree that pass a test
unist-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.