Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

unist-util-visit

Package Overview
Dependencies
3
Maintainers
2
Versions
21
Issues
File Explorer

Advanced tools

unist-util-visit

unist utility to visit nodes

    4.1.1latest

Version published
Maintainers
2
Weekly downloads
8,387,774
decreased by-13.55%

Weekly downloads

Changelog

Source

4.1.1

  • 6742b2d Fix TypeScript node16 and ESM by @alecmev in https://github.com/syntax-tree/unist-util-visit/pull/35
  • 6789ad5 Add improved docs
  • d190ee7 Fix typo by @jangxyz in https://github.com/syntax-tree/unist-util-visit/pull/34

Full Changelog: https://github.com/syntax-tree/unist-util-visit/compare/4.1.0...4.1.1

Readme

Source

unist-util-visit

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to walk the tree.

Contents

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.

Install

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/[email protected]"

In browsers with esm.sh:

<script type="module"> import {visit} from "https://esm.sh/[email protected]?bundle" </script>

Use

import {u} from 'unist-builder' import {visit} from 'unist-util-visit' const tree = u('tree', [ u('leaf', '1'), u('node', [u('leaf', '2')]), u('void'), u('leaf', '3') ]) visit(tree, 'leaf', (node) => { console.log(node) })

Yields:

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

API

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.

Types

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.

Compatibility

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.

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

Keywords

FAQs

What is unist-util-visit?

unist utility to visit nodes

Is unist-util-visit popular?

The npm package unist-util-visit receives a total of 7,994,452 weekly downloads. As such, unist-util-visit popularity was classified as popular.

Is unist-util-visit well maintained?

We found that unist-util-visit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 2 open source maintainers collaborating on the project.

Last updated on 21 Aug 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc