Nucleus Powered Mitochondria

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

    2.0.0 • Public • Published

    unist-util-visit-children

    Build Coverage Downloads Size Sponsors Backers Chat

    unist utility to visit direct children of a parent.

    Install

    This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

    npm:

    npm install unist-util-visit-children

    Use

    import u from 'unist-builder'
    import {visitChildren} from 'unist-util-visit-children'
    
    var visit = visitChildren(function(node) {
      console.log(node)
    })
    
    var tree = u('tree', [
      u('leaf', 'leaf 1'),
      u('node', [u('leaf', 'leaf 2'), u('leaf', 'leaf 3')]),
      u('leaf', 'leaf 4'),
      u('void')
    ])
    
    visit(tree)

    Yields:

    {type: 'leaf', value: 'leaf 1'}
    {
      type: 'node',
      children: [
        {type: 'leaf', value: 'leaf 2'},
        {type: 'leaf', value: 'leaf 3'}
      ]
    }
    {type: 'leaf', value: 'leaf 4'}
    {type: 'void'}

    API

    This package exports the following identifiers: visitChildren. There is no default export.

    visit = visitChildren(visitor)

    Wrap visitor to be called for each child in the nodes later given to visit.

    function visitor(child, index, parent)

    Called if visit is called on a parent node for each child.

    function visit(parent)

    Called visitor for each child of the parent.

    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, organisation, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i unist-util-visit-children

    DownloadsWeekly Downloads

    177,989

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    9.76 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm
    • kmck