unified

Project: syntax-tree/unist-util-find-before

Package: unist-util-find-before@3.0.0

  1. Dependents: 0
  2. unist utility to find a node before another node
  1. util 147
  2. utility 143
  3. unist 133
  4. unist-util 25
  5. node 25
  6. find 11
  7. before 2

unist-util-find-before

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to find a node before another node.

Contents

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 only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with npm:

npm install unist-util-find-before

In Deno with esm.sh:

import {findBefore} from "https://esm.sh/unist-util-find-before@3"

In browsers with esm.sh:

<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 findBefore. There is no default export.

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

Find the first node in parent (Parent) before another node (Node) or before an index, that passes test (Test from unist-util-is).

Returns

Child of parent that passes test, if found (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.

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

License

MIT © Titus Wormer