unified

Project:syntax-tree/unist-util-visit

Package:unist-util-visit@2.0.2

  1. Dependencies:3·Dependents:702
  2. unist utility to visit nodes
  1. remark 166
  2. markdown 82
  3. hast 78
  4. rehype 76
  5. mdast 68
  6. util 67
  7. utility 67
  8. unist 56
  9. html 56
  10. tree 37
  11. retext 33
  12. ast 27
  13. unist-util 23
  14. node 21
  15. nlcst 13
  16. language 12
  17. natural 9
  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