unified

Project: syntax-tree/unist-util-visit

Package: unist-util-visit@2.0.3

  1. Dependencies: 3·Dependents: 983
  2. unist utility to visit nodes
  1. remark 188
  2. markdown 133
  3. util 130
  4. utility 126
  5. unist 120
  6. html 109
  7. mdast 87
  8. rehype 73
  9. hast 62
  10. tree 44
  11. retext 33
  12. ast 32
  13. unist-util 26
  14. node 23
  15. nlcst 14
  16. language 12
  17. natural 10
  18. walk 8
  19. xast 7
  20. xml 7
  21. visit 6

unist-util-visit

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to visit nodes.

Install

npm:

npm install unist-util-visit

Use

var u = require('unist-builder')
var visit = require('unist-util-visit')

var tree = u('tree', [
  u('leaf', '1'),
  u('node', [u('leaf', '2')]),
  u('void'),
  u('leaf', '3')
])

visit(tree, 'leaf', function(node) {
  console.log(node)
})

Yields:

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

API

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.

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