Wondering what’s next for npm?Check out our public roadmap! »

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

    3.1.0 • Public • Published

    unist-util-visit

    Build Coverage Downloads Size Sponsors Backers Chat

    unist utility to visit nodes.

    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

    Use

    import {u} from 'unist-builder'
    import {visit} from 'unist-util-visit'
    
    const tree = u('tree', [
      u('leaf', '1'),
      u('node', [u('leaf', '2')]),
      u('void'),
      u('leaf', '3')
    ])
    
    visit(tree, 'leaf', (node) => {
      console.log(node)
    })

    Yields:

    { type: 'leaf', value: '1' }
    { type: 'leaf', value: '2' }
    { type: 'leaf', value: '3' }

    API

    This package exports the following identifiers: visit, CONTINUE, SKIP, and EXIT. There is no default export.

    visit(tree[, test], visitor[, reverse])

    This function works exactly the same as unist-util-visit-parents, but visitor has a different signature.

    next? = visitor(node, index, parent)

    Instead of being passed an array of ancestors, visitor is invoked with the node’s index and its parent. The optional return value next is documented in unist-util-visit-parents’s readme.

    Otherwise the same as unist-util-visit-parents.

    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-visit

    DownloadsWeekly Downloads

    5,153,762

    Version

    3.1.0

    License

    MIT

    Unpacked Size

    12 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar