package
unist utility to visit nodes
npm install unist-util-visitGitHub-flavored package documentation.
Across all versions, last 30 days.
397,781,068 in 30 days
Runtime metadata.
Tagged topics.
Estimated unpacked size across 4 packages.
133.3 kB
Includes dependencies.
kmck
keith@mcknig.ht
unist utility to walk the tree.
This is a very important utility for working with unist as it lets you walk the tree.
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.
npm install unist-util-visitIn 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'
</script>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])
})Yields:
[ 'Some ', 'paragraph' ]
[ 'emphasis', 'emphasis' ]
[ ', ', 'paragraph' ]
[ 'strong', 'strong' ]
[ ', and ', 'paragraph' ]
[ '.', 'paragraph' ]This package exports the identifiers
CONTINUE,
EXIT,
SKIP, and
visit.
It exports the TypeScript types
ActionTuple,
Action,
BuildVisitor,
BuildVisitors,
Index,
Test,
VisitorExit,
VisitorResultExit,
VisitorResult,
Visitors, and
Visitor.
There is no default export.
visit(tree[, test], enter|visitors[, reverse])This function works exactly the same as
unist-util-visit-parents,
but Visitor and VisitorExit have a
different signature.
visit(tree[, test], enter[, reverse])visit(tree[, test], visitors[, reverse])CONTINUEContinue traversing as normal (true).
EXITStop traversing immediately (false).
SKIPDo not traverse this node’s children ('skip').
ActionUnion of the action types (TypeScript type).
See Action in unist-util-visit-parents.
ActionTupleList with an action and an index (TypeScript type).
See ActionTuple in unist-util-visit-parents.
BuildVisitorBuild a typed Visitor function from a tree and a test (TypeScript type).
See BuildVisitor in unist-util-visit-parents.
BuildVisitorsBuild typed Visitors from a tree and a test (TypeScript
type).
See BuildVisitors in unist-util-visit-parents.
IndexMove to the sibling at index next (TypeScript type).
See Index in unist-util-visit-parents.
Testunist-util-is compatible test
(TypeScript type).
VisitorHandle a node (matching test, if given) before its children (TypeScript
type).
Like Visitor in unist-util-visit-parents,
but with index and parent instead of parents.
What to do next (VisitorResult).
VisitorExitHandle a node (matching test, if given) after its children (TypeScript type).
Like VisitorExit in unist-util-visit-parents,
but with index and parent instead of parents.
What to do next (VisitorResultExit).
VisitorResultAny value that can be returned from a visitor (TypeScript type).
See VisitorResult in
unist-util-visit-parents.
VisitorResultExitAny value that can be returned from an exit visitor (TypeScript type).
See VisitorResultExit in
unist-util-visit-parents.
VisitorsHandle nodes when entering and exiting them (TypeScript type).
See Visitors in unist-util-visit-parents.
enter (Visitor, optional)
— handle a node before its childrenexit (VisitorExit)
— handle a node after its childrenProjects 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.
unist-util-visit-parents
— walk the tree with a stack of parentsunist-util-filter
— create a new tree with all nodes that pass a testunist-util-map
— create a new tree with all nodes mapped by a given functionunist-util-flatmap
— create a new tree by mapping (to an array) with the given functionunist-util-remove
— remove nodes from a tree that pass a testunist-util-select
— select nodes with CSS-like selectorsSee 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.
^6.0.0
6.0.1
^6.1.0
6.1.0