unist-util-find-after

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 16+), install with npm:

npm install unist-util-find-after

In Deno with esm.sh:

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

In browsers with esm.sh:

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 after another node or after an index, that passes 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

Returns

Child of parent (Node) or undefined.

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.

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.

Related

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

Most popular functions for unist-util-find-after

To help you get started, we’ve selected a few unist-util-find-after examples, based on popular ways it is used in public projects.

unist-util-find-after