unified

Project: syntax-tree/unist-util-find-after

Package: unist-util-find-after@4.0.0

  1. Dependents: 0
  2. unist utility to find a node after another node
  1. util 52
  2. utility 48
  3. unist 47
  4. unist-util 25
  5. node 18
  6. find 8
  7. after 2

unist-util-find-after

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to find a node after another node.

Contents

What is this?

This is a tiny utility that you can use to find a node after another node or after 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 only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with npm:

npm install unist-util-find-after

In Deno with esm.sh:

import {findAfter} from "https://esm.sh/unist-util-find-after@4"

In browsers with esm.sh:

<script type="module">
  import {findAfter} from "https://esm.sh/unist-util-find-after@4?bundle"
</script>

Use

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:

{type: 'parent', children: [{ type: 'leaf', value: 'leaf 5'}]}

API

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

findAfter(parent, node|index[, test])

Find the first node in parent (Parent) after another node (Node) or after an index, that passes test (Test from unist-util-is).

Returns

Child of parent that passes test, if found (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 all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer