unist utility to find a node after another node
npm install unist-util-find-after[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
[unist][] utility to find a node after another node.
* What is this?
* When should I use this?
* Install
* Use
* API
* [findAfter(parent, node|index[, test])](#findafterparent-nodeindex-test)
* Types
* Compatibility
* Related
* Contribute
* License
This is a tiny utility that you can use to find a node after another node or
after an index 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][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install unist-util-find-after
In Deno with [esm.sh][esmsh]:
`js`
import {findAfter} from 'https://esm.sh/unist-util-find-after@5'
In browsers with [esm.sh][esmsh]:
`html`
`js
import {u} from 'unist-builder'
import {findAfter} from 'unist-util-find-after'
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(findAfter(tree, 1, 'parent'))
`
Yields:
`js`
{type: 'parent', children: [{ type: 'leaf', value: 'leaf 5'}]}
This package exports the identifier [findAfter][api-findafter].
There is no default export.
Find the first node in parent after another node or after an index,test
that passes .
###### Parameters
* parent ([Node][node])index
— parent node
* (number)parent
— index of child in child
* ([Node][node])parent
— child in test
* ([Test][test])unist-util-is
— -compatible test
###### Returns
Child of parent ([Node][node]) or undefined.
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.
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-after@^5,
compatible with Node.js 16.
* 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 provided function and
then flattening
* 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-find-all-between
— find all nodes between two nodes
* unist-util-remove
— remove nodes from a tree that pass a test
* unist-util-select
— select nodes with CSS-like selectors
See [contributing.md][contributing] in [syntax-tree/.github][health] forsupport.md`][support] for ways to get help.
ways to get started.
See [
This project has a [Code of Conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/syntax-tree/unist-util-find-after/workflows/main/badge.svg
[build]: https://github.com/syntax-tree/unist-util-find-after/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-find-after.svg
[coverage]: https://codecov.io/github/syntax-tree/unist-util-find-after
[downloads-badge]: https://img.shields.io/npm/dm/unist-util-find-after.svg
[downloads]: https://www.npmjs.com/package/unist-util-find-after
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=unist-util-find-after
[size]: https://bundlejs.com/?q=unist-util-find-after
[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://wooorm.com
[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-findafter]: #findafterparent-nodeindex-test