Project: syntax-tree/unist-util-visit

Package: unist-util-visit@4.1.1

  1. Dependents: 0
  2. unist utility to visit nodes
  1. remark 187
  2. util 136
  3. markdown 136
  4. utility 132
  5. unist 128
  6. html 118
  7. rehype 84
  8. mdast 84
  9. hast 72
  10. retext 34
  11. tree 31
  12. ast 29
  13. unist-util 25
  14. node 23
  15. nlcst 14
  16. xast 8
  17. xml 8
  18. walk 8
  19. language 7
  20. visit 6
  21. natural 4


Build Coverage Downloads Size Sponsors Backers Chat

unist utility to walk the tree.


What is this?

This is a very important utility for working with unist as it lets you walk the tree.

When should I use this?

You can use this utility when you want to walk the tree. You can use unist-util-visit-parents if you care about the entire stack of parents.


This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with npm:

npm install unist-util-visit

In Deno with esm.sh:

import {visit} from "https://esm.sh/unist-util-visit@4"

In browsers with esm.sh:

<script type="module">
  import {visit} from "https://esm.sh/unist-util-visit@4?bundle"


import {u} from 'unist-builder'
import {visit} from 'unist-util-visit'

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

visit(tree, 'leaf', (node) => {


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


This package exports the 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.

Please see unist-util-visit-parents.


This package is fully typed with TypeScript. It exports the additional types Test, VisitorResult, and Visitor.

It also exports the types BuildVisitor<Tree extends Node = Node, Check extends Test = string> to properly type visitors from a tree and a test, from unist-util-visit-parents/complex-types.d.ts.


Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.


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.


MIT © Titus Wormer