unist utility to find the nodes between two nodes.
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Related
- Contribute
- License
This is a tiny utility that you can use to find nodes between two nodes or indexes in a parent.
This is super tiny. You can of course do it yourself. But this helps when integrating with the rest of unified and unist.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install unist-util-find-between-all
In Deno with esm.sh
:
import {findAllBetween} from 'https://esm.sh/unist-util-find-between-all@1'
In browsers with esm.sh
:
<script type="module">
import {findAllBetween} from 'https://esm.sh/unist-util-find-between-all@1?bundle'
</script>
import {u} from 'unist-builder'
import {findAllBetween} from 'unist-util-find-between-all'
const tree = u('tree', [
u('leaf', 'leaf 1'),
u('parent', [u('leaf', 'leaf 2'), u('leaf', 'leaf 3')]),
u('leaf', 'leaf 4'),
u('parent', [u('leaf', 'leaf 5')]),
u('leaf', 'leaf 6'),
u('empty'),
u('leaf', 'leaf 7')
])
console.log(findAllBetween(tree, 1, 5, 'leaf'))
Yields:
[
{type: 'leaf', value: 'leaf 4'},
{type: 'leaf', value: 'leaf 6'},
]
This package exports the identifier findAllBetween
.
There is no default export.
Find the nodes in parent
between two child
s or indexes, that pass test
.
parent
(Node
) — parent nodeindex
(number
) — index of child inparent
child
(Node
) — child inparent
test
(Test
) —unist-util-is
-compatible testoptions
([{behaviour: "include" | "exclude"}
][options]) — The behaviour for including or excluding (default) both sides (optional).
Children of parent
(Array<Node>
).
This package is fully typed with TypeScript.
It exports no additional types (types for the test are in unist-util-is
).
Projects maintained by the unified collective are compatible with maintained versions of Node.js. As of now, that is Node.js 16+. Our projects sometimes work with older versions, but this is not guaranteed.
unist-util-visit
— walk the treeunist-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-find-after
— find a node after another nodeunist-util-find-before
— find a node before another nodeunist-util-find-all-after
— find all nodes after another nodeunist-util-find-all-before
— find all nodes before another nodeunist-util-remove
— remove nodes from a tree that pass a testunist-util-select
— select nodes with CSS-like selectors
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.