unist-util-find-between-all

unist utility to find the nodes between two nodes.

What is this?
When should I use this?
Install
Use
API
- findAllBetween(parent, child|index, child|index[, test])
Types
Compatibility
Related
Contribute
License

What is this?

This is a tiny utility that you can use to find nodes between two nodes or indexes 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 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>

Use

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'},
]

API

This package exports the identifier findAllBetween. There is no default export.

`findAllBetween(parent, child|index, child|index[, test][, options])`

Find the nodes in parent between two childs or indexes, that pass test.

Parameters

parent (Node) — parent node
index (number) — index of child in parent
child (Node) — child in parent
test (Test) — unist-util-is-compatible test
options ([{behaviour: "include" | "exclude"}][options]) — The behaviour for including or excluding (default) both sides (optional).

Returns

Children of parent (Array<Node>).

Types

This package is fully typed with TypeScript. It exports no additional types (types for the test are in unist-util-is).

Compatibility

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 tree
unist-util-visit-parents — walk the tree with a stack of parents
unist-util-filter — create a new tree with all nodes that pass a test
unist-util-map — create a new tree with all nodes mapped by a given function
unist-util-flatmap — create a new tree by mapping (to an array) with the given function
unist-util-find-after — find a node after another node
unist-util-find-before — find a node before another node
unist-util-find-all-after — find all nodes after another node
unist-util-find-all-before — find all nodes before another node
unist-util-remove — remove nodes from a tree that pass a test
unist-util-select — select nodes with CSS-like selectors

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.