unified

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

Package: unist-util-modify-children@3.0.0

  1. Dependents: 0
  2. unist utility to modify direct children of a parent
  1. util 147
  2. utility 143
  3. unist 133
  4. tree 44
  5. ast 36
  6. unist-util 25
  7. children 2

unist-util-modify-children

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to change children of a parent.

Contents

What is this?

This is a tiny utility that you can use to create a reusable function that modifies children.

When should I use this?

Probably never! Use unist-util-visit.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with npm:

npm install unist-util-modify-children

In Deno with esm.sh:

import {modifyChildren} from "https://esm.sh/unist-util-modify-children@3"

In browsers with esm.sh:

<script type="module">
  import {modifyChildren} from "https://esm.sh/unist-util-modify-children@3?bundle"
</script>

Use

import u from 'unist-builder'
import {modifyChildren} from 'unist-util-modify-children'

const tree = u('root', [
  u('leaf', '1'),
  u('parent', [u('leaf', '2')]),
  u('leaf', '3')
])
const modify = modifyChildren(function (node, index, parent) {
  if (node.type === 'parent') {
    parent.children.splice(index, 1, {type: 'subtree', children: parent.children})
    return index + 1
  }
})

modify(tree)

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

Yields:

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

API

This package exports the identifier modifyChildren. There is no default export.

modifyChildren(modifier)

Wrap modifier to be called for each child in the nodes later given to modify.

Returns

Modify.

next? = modifier(child, index, parent)

Callback called for each child in parent later given to modify.

Returns

Position to move to next (number?).

modify(parent)

Call the bound modifier for each child in parent (Parent).

Types

This package is fully typed with TypeScript. It exports the additional types Modifier and Modify.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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.

License

MIT © Titus Wormer