unist-util-modify-children

unist-util-modify-children

Modify direct children of a parent.

Installation

npm:

npm install unist-util-modify-children

Usage

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

var doc = remark()
  .use(plugin)
  .process('This _and_ that')

console.log(String(doc))

function plugin() {
  return transformer
  function transformer(tree) {
    modifyChildren(modifier)(tree.children[0])
  }
}

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

Yields:

This **and** that

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).

Contribute

See contribute.md in syntax-tree/unist for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer