unist-util-find-all-before
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatunist utility to find nodes before another node.
Contents
* [`findAllBefore(parent, child|index[, test])`](#findallbeforeparent-childindex-test)
What is this?
This is a tiny utility that you can use to find nodes before another node or before an index in a parent.When should I use this?
This is super tiny. You can of course do it yourself. But this helps when integrating with the rest of unified and unist.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install unist-util-find-all-before
In Deno with
esm.sh
esmsh:import {findAllBefore} from 'https://esm.sh/unist-util-find-all-before@5'
In browsers with
esm.sh
esmsh:<script type="module">
import {findAllBefore} from 'https://esm.sh/unist-util-find-all-before@5?bundle'
</script>
Use
import {u} from 'unist-builder'
import {findAllBefore} from 'unist-util-find-all-before'
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')
])
const leaf6 = tree.children[4]
console.log(findAllBefore(tree, leaf6, 'leaf'))
Yields:
[
{ type: 'leaf', value: 'leaf 1' },
{ type: 'leaf', value: 'leaf 4' }
]
API
This package exports the identifierfindAllBefore
api-find-all-before.
There is no default export.findAllBefore(parent, child|index[, test])
Find the nodes in parent
before another node
or before an index,
that pass test
.Parameters
— parent node
index
(number
)
— index of child in `parent`
— child in `parent`
— `unist-util-is`-compatible test
Returns
Children ofparent
(Array<Node>
node).Types
This package is fully typed with TypeScript. It exports no additional types (types for the test are inunist-util-is
).Compatibility
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-find-all-before@^5
, compatible with Node.js 16.Related
— find a node after another node
— find a node before another node
— find all nodes after another node
— find all nodes between two nodes
— walk the tree
— walk the tree with a stack of parents
— create a new tree with all nodes that pass a test
— create a new tree with all nodes mapped by a given function
— create a new tree by mapping (to an array) with a given function
— remove nodes from a tree that pass a test
— select nodes with CSS-like selectors
Contribute
Seecontributing.md
contributing in syntax-tree/.github
health for
ways to get started.
See support.md
support for ways to get help.This project has a Code of Conductcoc. By interacting with this repository, organisation, or community you agree to abide by its terms.