unist-util-find-before

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 install unist-util-find-before

Use

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

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

const 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

parent (Node) — Parent node
node (Node) — Child of parent
index (number, optional) — Index in parent
test (Function, string, Object, Array, optional) — See unist-util-is

Returns

Node? — Child of parent passing test.

unist-util-find-after — Find a node after another node
unist-util-find-all-after — Find all nodes after another node
unist-util-find-all-before — Find all nodes before another node
unist-util-find-all-between — Find all nodes between two nodes
unist-util-visit — Recursively walk over nodes
unist-util-visit-parents — Like visit, but with a stack of parents
unist-util-filter — Create a new tree with all nodes that pass a test
unist-util-map — Create a new tree with all nodes mapped by a given function
unist-util-flatmap — Create a new tree by mapping (to an array) by a given function
unist-util-remove — Remove nodes from a tree that pass a test
unist-util-select — Select nodes with CSS-like selectors

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.

christianmurphy / unist-util-find-before Goto Github PK