Nice Poodle, Mister

    unist-util-modify-children
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.1 • Public • Published

    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 14.14+ and 16.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.

    Parameters
    • modifier (Modifier) — callback called for each child in parent later given to modify
    Returns

    Modify children of parent (Modify).

    Modifier

    Callback called for each child in parent later given to modify (TypeScript type).

    Parameters
    • child (Node) — child of parent
    • index (number) — position of child in parent
    • parent (Node) — parent node
    Returns

    Position to move to next (optional) (number or void).

    Modify

    Modify children of parent (TypeScript type).

    Parameters
    • parent (Node) — parent node
    Returns

    Nothing (void).

    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 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    Related

    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

    Install

    npm i unist-util-modify-children

    DownloadsWeekly Downloads

    264,620

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    13.6 kB

    Total Files

    7

    Last publish

    Collaborators

    • wooorm
    • kmck