Package Exports

unist-util-modify-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-modify-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-modify-children

Modify direct children of a parent.

Install

npm:

npm install unist-util-modify-children

Use

var u = require('unist-builder')
var modifyChildren = require('unist-util-modify-children')

var modify = modifyChildren(modifier)

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

modify(tree)

console.dir(tree, {depth: null})

function modifier(node, index, parent) {
  if (node.type === 'node') {
    parent.children.splice(index, 1, {type: 'subtree', children: node.children})
    return index + 1
  }
}

Yields:

{
  type: 'root',
  children: [
    {type: 'leaf', value: '1'},
    {type: 'subtree', children: [{type: 'leaf', value: '2'}]},
    {type: 'leaf', value: '3'}
  ]
}

API

`modify = modifyChildren(modifier)`

Wrap modifier to be invoked for each child in the node given to modify.

`next? = modifier(child, index, parent)`

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

Returns

number (optional) — Next position to iterate.

`function modify(parent)`

Invoke the bound modifier for each child in parent (Node).

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 provided function and then flattening
unist-util-find-after — Find a node after another node
unist-util-find-before — Find a node before another node
unist-util-find-all-after — Find all nodes after another node
unist-util-find-all-before — Find all nodes 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, organization, or community you agree to abide by its terms.