Repository files navigation

unist utility to change children of a parent.

• What is this?
• When should I use this?
• Install
• Use
• API
  • modifyChildren(modifier)
  • Modifier
  • Modify
• Types
• Compatibility
• Related
• Contribute
• License

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

Probably never!Useunist-util-visit.

This package isESM only.In Node.js (version 16+), install withnpm:

npm install unist-util-modify-children

In Deno withesm.sh:

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

In browsers withesm.sh:

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

importufrom'unist-builder'import{modifyChildren}from'unist-util-modify-children'consttree=u('root',[u('leaf','1'),u('parent',[u('leaf','2')]),u('leaf','3')])constmodify=modifyChildren(function(node,index,parent){if(node.type==='parent'){parent.children.splice(index,1,{type:'subtree',children:parent.children})returnindex+1}})modify(tree)console.dir(tree,{depth:undefined})

Yields:

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

This package exports the identifiermodifyChildren.There is no default export.

Wrapmodifier to be called for each child in the nodes later given tomodify.

• modifier (Modifier)— callback called for eachchild inparent later given tomodify

Modify children ofparent (Modify).

Callback called for eachchild inparent later given tomodify(TypeScript type).

• child (Node)— child ofparent
• index (number)— position ofchild inparent
• parent (Node)— parent node

Position to move to next (optional) (number orundefined).

Modify children ofparent (TypeScript type).

• parent (Node)— parent node

Nothing (undefined).

This package is fully typed withTypeScript.It exports the additional typesModifier andModify.

Projects maintained by the unified collective are compatible with maintainedversions of Node.js.

When we cut a new major release, we drop support for unmaintained versions ofNode.This means we try to keep the current release line,unist-util-modify-children@^4, compatible with Node.js 16.

• unist-util-visit— walk the tree
• unist-util-visit-parents— walk the tree 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-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

Seecontributing.md insyntax-tree/.github forways to get started.Seesupport.md for ways to get help.

This project has acode of conduct.By interacting with this repository, organization, or community you agree toabide by its terms.

MIT ©Titus Wormer