unified

Project: syntax-tree/unist-util-visit

Package: unist-util-visit@4.1.0

  1. Dependents: 1k
  2. unist utility to visit nodes
  1. remark 196
  2. util 144
  3. utility 140
  4. markdown 139
  5. unist 127
  6. html 122
  7. rehype 87
  8. mdast 83
  9. hast 73
  10. tree 41
  11. retext 36
  12. ast 33
  13. unist-util 25
  14. node 25
  15. nlcst 14
  16. language 11
  17. natural 9
  18. xast 8
  19. xml 8
  20. walk 8
  21. visit 6

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' }

Note: this example also uses unist-builder, to run the example ensure both unist-builder and unist-util-visit are installed:

npm install unist-builder unist-util-visit

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 called 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.

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