Project: syntax-tree/unist-util-visit

Package: unist-util-visit@4.1.1

  1. Dependents: 0
  2. unist utility to visit nodes
  1. remark 214
  2. markdown 154
  3. util 145
  4. utility 141
  5. unist 132
  6. html 124
  7. rehype 88
  8. mdast 88
  9. hast 74
  10. tree 44
  11. retext 42
  12. ast 37
  13. unist-util 25
  14. node 24
  15. nlcst 15
  16. language 12
  17. xml 10
  18. natural 9
  19. xast 8
  20. walk 8
  21. visit 6


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 16+), install with npm:

npm install unist-util-visit

In Deno with esm.sh:

import {CONTINUE, EXIT, SKIP, visit} from 'https://esm.sh/unist-util-visit@5'

In browsers with esm.sh:

<script type="module">
  import {CONTINUE, EXIT, SKIP, visit} from 'https://esm.sh/unist-util-visit@5?bundle'


import {fromMarkdown} from 'mdast-util-from-markdown'
import {visit} from 'unist-util-visit'

const tree = fromMarkdown('Some *emphasis*, **strong**, and `code`.')

visit(tree, 'text', function (node, index, parent) {
  console.log([node.value, parent ? parent.type : index])


[ 'Some ', 'paragraph' ]
[ 'emphasis', 'emphasis' ]
[ ', ', 'paragraph' ]
[ 'strong', 'strong' ]
[ ', and ', 'paragraph' ]
[ '.', 'paragraph' ]


This package exports the identifiers CONTINUE, EXIT, SKIP, and visit. 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.


Continue traversing as normal (true).


Stop traversing immediately (false).


Do not traverse this node’s children ('skip').


Union of the action types (TypeScript type). See Action in unist-util-visit-parents.


List with an action and an index (TypeScript type). See ActionTuple in unist-util-visit-parents.


Build a typed Visitor function from a tree and a test (TypeScript type). See BuildVisitor in unist-util-visit-parents.


Move to the sibling at index next (TypeScript type). See Index in unist-util-visit-parents.


unist-util-is compatible test (TypeScript type).


Handle a node (matching test, if given) (TypeScript type).

Visitors are free to transform node. They can also transform parent.

Replacing node itself, if SKIP is not returned, still causes its descendants to be walked (which is a bug).

When adding or removing previous siblings of node (or next siblings, in case of reverse), the Visitor should return a new Index to specify the sibling to traverse after node is traversed. Adding or removing next siblings of node (or previous siblings, in case of reverse) is handled as expected without needing to return a new Index.

Removing the children property of parent still results in them being traversed.


What to do next.

An Index is treated as a tuple of [CONTINUE, Index]. An Action is treated as a tuple of [Action].

Passing a tuple back only makes sense if the Action is SKIP. When the Action is EXIT, that action can be returned. When the Action is CONTINUE, Index can be returned.


Any value that can be returned from a visitor (TypeScript type). See VisitorResult in unist-util-visit-parents.


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


Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, unist-util-visit@^5, compatible with Node.js 16.


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