unist-util-find-between-all

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
[![Size][size-badge]][size]

[unist][] utility to find the nodes between two nodes.

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* [findAllBetween(parent, child|index, child|index[, test])](#findallbetweenparent-childindex-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][esm].
In Node.js (version 16+), install with [npm][]:

``sh
npm install unist-util-find-between-all
`

In Deno with [esm.sh][esmsh]:

`js
import {findAllBetween} from 'https://esm.sh/unist-util-find-between-all@1'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

`js
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:

`js
[
{type: 'leaf', value: 'leaf 4'},
{type: 'leaf', value: 'leaf 6'},
]
`

API

This package exports the identifier [findAllBetween][api-find-all-between].
There is no default export.

$3

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

###### Parameters

* parent ([Node][node])
— parent node
* index (number)
— index of child in parent
* child ([Node][node])
— child in parent
* test ([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.

Related

* 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][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 conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[MIT][license] © [Talat Kuyuk][author]

[build-badge]: https://github.com/ipikuka/unist-util-find-between-all/workflows/main/badge.svg

[build]: https://github.com/ipikuka/unist-util-find-between-all/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/ipikuka/unist-util-find-between-all.svg

[coverage]: https://codecov.io/github/ipikuka/unist-util-find-between-all

[downloads-badge]: https://img.shields.io/npm/dm/unist-util-find-between-all.svg

[downloads]: https://www.npmjs.com/package/unist-util-find-between-all

[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=unist-util-find-between-all

[size]: https://bundlejs.com/?q=unist-util-find-between-all

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/syntax-tree/unist/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[license]: license

[author]: https://www.npmjs.com/~talatkuyuk

[health]: https://github.com/syntax-tree/.github

[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md

[support]: https://github.com/syntax-tree/.github/blob/main/support.md

[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md

[unist]: https://github.com/syntax-tree/unist

[node]: https://github.com/syntax-tree/unist#node

[test]: https://github.com/syntax-tree/unist-util-is#test

[api-find-all-between]: #findallbetweenparent-childindex-test