Nutella Per Minute

    unist-util-find-after
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.1 • Public • Published

    unist-util-find-after

    Build Coverage Downloads Size Sponsors Backers Chat

    unist utility to find a node after another node.

    Contents

    What is this?

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

    npm install unist-util-find-after

    In Deno with esm.sh:

    import {findAfter} from 'https://esm.sh/unist-util-find-after@4'

    In browsers with esm.sh:

    <script type="module">
      import {findAfter} from 'https://esm.sh/unist-util-find-after@4?bundle'
    </script>

    Use

    import {u} from 'unist-builder'
    import {findAfter} from 'unist-util-find-after'
    
    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')
    ])
    
    console.log(findAfter(tree, 1, 'parent'))

    Yields:

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

    API

    This package exports the identifier findAfter. There is no default export.

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

    Find the first node in parent after another node or after an index, that passes test.

    Parameters
    • parent (Node) — parent node
    • index (number) — index of child in parent
    • child (Node) — child in parent
    • test (Test) — unist-util-is-compatible test
    Returns

    Child of parent (Node) 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

    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

    Install

    npm i unist-util-find-after

    DownloadsWeekly Downloads

    272,974

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    11.7 kB

    Total Files

    7

    Last publish

    Collaborators

    • wooorm
    • kmck