unist-util-find-before

unist utility to find a node before another node

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
unist-util-find-before
403.0.18 days ago7 years agoMinified + gzip package size for unist-util-find-before in KB

Readme

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

Contents

*   [`findBefore(parent, node|index[, test])`](#findbeforeparent-nodeindex-test)

What is this?

This is a tiny utility that you can use to find a node before 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 14.14+ and 16.0+), install with npm:
npm install unist-util-find-before

In Deno with esm.shesmsh:
import {findBefore} from 'https://esm.sh/unist-util-find-before@3'

In browsers with esm.shesmsh:
<script type="module">
  import {findBefore} from 'https://esm.sh/unist-util-find-before@3?bundle'
</script>

Use

import {u} from 'unist-builder'
import {findBefore} from 'unist-util-find-before'

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')
])

const empty = tree.children[5]

console.log(findBefore(tree, empty, 'parent'))

Yields:
{type: 'parent', children: [{type: 'leaf', value: 'leaf 5'}]}

API

This package exports the identifier findBeforeapi-findbefore. There is no default export.

findBefore(parent, node|index[, test])

Find the first node in parent before another node or before an index, that passes test.
Parameters
— parent node
  • index (number)
— index of child in `parent`
— child in `parent`
— `unist-util-is`-compatible test
Returns
Child of parent (Nodenode) or null.

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.

Related

— find a node after another node
— find all nodes after another node
— find all nodes before another node
— find all nodes between two nodes
— 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) by a given function
— 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, organisation, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor