unist-util-find-all-after

What is unist-util-find-all-after?

The `unist-util-find-all-after` package is a utility for working with unist syntax trees. It allows you to find all nodes that come after a specified node in a tree, which can be useful for various tree manipulations and traversals.

What are unist-util-find-all-after's main functionalities?

Find all nodes after a given node

This feature allows you to find all nodes that come after a specified node in a unist tree. In this example, it finds all nodes that come after the first paragraph node.

const findAllAfter = require('unist-util-find-all-after');
const tree = {
  type: 'root',
  children: [
    { type: 'paragraph', value: 'First paragraph' },
    { type: 'paragraph', value: 'Second paragraph' },
    { type: 'paragraph', value: 'Third paragraph' }
  ]
};
const node = tree.children[0];
const result = findAllAfter(tree, node);
console.log(result);

Find all nodes of a specific type after a given node

This feature allows you to find all nodes of a specific type that come after a specified node in a unist tree. In this example, it finds all heading nodes that come after the first paragraph node.

const findAllAfter = require('unist-util-find-all-after');
const tree = {
  type: 'root',
  children: [
    { type: 'paragraph', value: 'First paragraph' },
    { type: 'heading', value: 'First heading' },
    { type: 'paragraph', value: 'Second paragraph' }
  ]
};
const node = tree.children[0];
const result = findAllAfter(tree, node, 'heading');
console.log(result);

Other packages similar to unist-util-find-all-after

unist-util-visit

The `unist-util-visit` package is used to recursively walk through unist syntax trees. It allows you to visit nodes based on their type and perform actions on them. Unlike `unist-util-find-all-after`, which focuses on finding nodes after a specific node, `unist-util-visit` is more general-purpose and can be used for a variety of tree traversal tasks.

unist-util-select

The `unist-util-select` package provides a CSS-like selector API for unist syntax trees. It allows you to query nodes in a tree using selectors, making it more flexible for complex queries compared to `unist-util-find-all-after`, which is more straightforward and focused on finding nodes after a specific point.

README

unist-util-find-all-after

unist utility to find nodes after another node.

Install

npm:

npm install unist-util-find-all-after

Use

var u = require('unist-builder')
var findAllAfter = require('unist-util-find-all-after')

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

console.log(findAllAfter(tree, 1, 'leaf'))

Yields:

[
  {type: 'leaf', value: 'leaf 4'},
  {type: 'leaf', value: 'leaf 6'},
  {type: 'leaf', value: 'leaf 7'}
]

API

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

Find all children after index (or node) in parent that pass test (when given).

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

Array.<Node> — Children of parent passing test.

Related

• 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) with the given function
• unist-util-find-after — Find a node after another node
• unist-util-find-before — Find a node before 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-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, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer