unified

Project: syntax-tree/unist-util-visit

Package: unist-util-visit@2.0.3

  1. Dependencies: 3·Dependents: 879
  2. unist utility to visit nodes
  1. remark 141
  2. util 115
  3. utility 113
  4. html 108
  5. unist 106
  6. markdown 78
  7. rehype 69
  8. hast 59
  9. mdast 48
  10. tree 42
  11. retext 30
  12. ast 29
  13. unist-util 24
  14. node 21
  15. nlcst 12
  16. language 12
  17. natural 10
  18. walk 7
  19. xast 5
  20. xml 5
  21. visit 5

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.

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