unified

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

Package: unist-util-find-before@3.0.0

  1. Dependencies: 2·Dependents: 10
  2. unist utility to find a node before another node
  1. util 136
  2. utility 132
  3. unist 119
  4. unist-util 25
  5. node 23
  6. find 10
  7. before 2

unist-util-find-before

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to find a node before another node.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install unist-util-find-before

Use

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

var tree = u('tree', [
  u('leaf', 'leaf 1'),
  u('node', [u('leaf', 'leaf 2'), u('leaf', 'leaf 3')]),
  u('leaf', 'leaf 4'),
  u('node', [u('leaf', 'leaf 5')]),
  u('leaf', 'leaf 6'),
  u('void'),
  u('leaf', 'leaf 7')
])

var empty = tree.children[5]

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

Yields:

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

API

This package exports the following identifiers: findBefore. There is no default export.

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

Find the first child before index (or node) in parent, that passes test.

Parameters
Returns

Node?Child of parent passing test.

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