unified

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

Package: unist-util-find-all-after@4.0.0

  1. Dependents: 0
  2. unist utility to find nodes after another node
  1. util 145
  2. utility 141
  3. unist 132
  4. tree 44
  5. unist-util 25
  6. node 25
  7. find 11
  8. after 2

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 14.14+ and 16.0+), 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@4'

In browsers with esm.sh:

<script type="module">
  import {findAllAfter} from 'https://esm.sh/unist-util-find-all-after@4?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
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 all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.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, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer