Skip to content

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

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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 12.20+, 14.14+, 16.0+, 18.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, node|index[, test])

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

Returns

Children of parent that pass test (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 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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