unist-util-find-all-after

unist utility to find nodes after another node

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
unist-util-find-all-after
605.0.0a year ago9 years agoMinified + gzip package size for unist-util-find-all-after in KB

Readme

unist-util-find-all-after
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat !Sizesize-badgesize
unist utility to find nodes after another node.

Contents

*   [`findAllAfter(parent, child|index[, test])`](#findallafterparent-childindex-test)

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 onlyesm. In Node.js (version 16+), install with npm:
npm install unist-util-find-all-after

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

In browsers with esm.shesmsh:
<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 findAllAfterapi-find-all-after. 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
  • index (number)
— index of child in `parent`
— child in `parent`
— `unist-util-is`-compatible test
Returns
Children of parent (Array<Node>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

— walk the tree
— walk the tree with a stack of parents
— create a new tree with all nodes that pass a test
— create a new tree with all nodes mapped by a given function
— create a new tree by mapping (to an array) with the given function
— find a node after another node
— find a node before another node
— find all nodes after another node
— find all nodes before another node
— find all nodes between two nodes
— remove nodes from a tree that pass a test
— select nodes with CSS-like selectors

Contribute

See contributing.mdcontributing in syntax-tree/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor