unist-util-find-all-after
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

unist-util-find-all-after

Build Coverage Downloads Sponsors Backers Chat Size

unist utility to find nodes after another node.

Contents

What is this?

This is a tiny utility that you can use to find nodes after another node or before 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-all-after

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

import {u} from 'unist-builder'
import {findAllAfter} from 'unist-util-find-all-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(findAllAfter(tree, 1, 'leaf'))

Yields:

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

API

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

findAllAfter(parent, child|index[, test])

Find the nodes in parent before a child or before an index, 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
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.

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

License

MIT © Titus Wormer

Package Sidebar

Install

npm i unist-util-find-all-after

Weekly Downloads

1,007,346

Version

5.0.0

License

MIT

Unpacked Size

15.7 kB

Total Files

7

Last publish

Collaborators

  • wooorm
  • kmck