npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@flex-development/unist-util-types

v1.6.1

Published

unist utility types

Downloads

210

Readme

unist-util-types

github release npm module type: esm license conventional commits typescript vitest yarn

unist utility types

Contents

What is this?

This package contains TypeScript definitions for working with unist and its ecosystem of utilities.

Install

This package is ESM only.

In Node.js (version 18+) with yarn:

yarn add @flex-development/unist-util-types

Use

import type {
  Ancestor,
  Children,
  Column,
  InclusiveDescendant,
  Index,
  Line,
  Match,
  MatchChildren,
  MatchInclusiveDescendant,
  MatchProperties,
  MatchValue,
  Offset,
  Parents,
  PositionalInfo,
  Test,
  TestFunction,
  Type,
  Value
} from '@flex-development/unist-util-types'

API

Ancestor<Tree, Child>

Collect nodes in Tree that can be ancestors of Child.

source: src/ancestor.ts

Children<T>

Extract children from tree T.

  • T (Node): tree to extract children from

source: src/children.ts

Column

Column in a source file (1-indexed integer).

source: src/column.ts

Decrement<[I]>

Subtract 1 from I while I is in the range [1, 10].

  • I (Uint): number to subtract from
    • default: 10

source: src/decrement.ts

InclusiveDescendant<Tree[, Max][, Depth]>

Collect all inclusive descendants of Tree.

  • Tree (Node): tree to collect descendants from
  • Max (Uint): maximum search depth
    • default: 10
  • Depth (Uint): current search depth
    • default: 0

source: src/descendant-inclusive.ts

Increment<[I]>

Add 1 to I while I is in the range [0, 9].

  • I (Uint): number to add to
    • default: 0

source: src/increment.ts

Index

Number of preceding siblings of a child node.

source: src/index-number.ts

IsAncestor<Tree, Child[, Max][, Depth]>

Check if Tree is an ancestor of Child.

  • Tree (Node): tree to check
  • Child (Node): expected child node
  • Max (Uint): maximum search depth
    • default: 10
  • Depth (Uint): current search depth
    • default: 0

source: src/is-ancestor.ts

IsParent<Tree, Child>

Check if Tree is the parent of Child.

source: src/is-parent.ts

Line

Line in a source file (1-indexed integer).

source: src/line.ts

Match<N, Check>

Check if node N passes a test.

  • N (Node): node to check
  • Check (Test): node test

source: src/match.ts

MatchChildren<N[, Check]>

Extract children from node N if it passes a test.

source: src/match-children.ts

MatchInclusiveDescendant<Tree, Check[, Max]>

Check if inclusive descendants of Tree pass a test.

  • Tree (Node): tree to check
  • Check (Test): node test
  • Max (Uint): maximum search depth
    • default: 10

source: src/src/match-descendant-inclusive.ts

MatchProperties<N[, Check]>

Extract properties of node N if it passes a test.

Properties of N are all fields except type.

source: src/match-properties.ts

MatchValue<N[, Check]>

Extract the value of node N if it passes a test.

source: src/match-value.ts

Offset

Index of a character in a source file (0-indexed integer).

source: src/offset.ts

Parents<Tree[, Child]>

Collect nodes in Tree that can be parents of Child.

All parents will be included in the resulting union if Child is any.

  • Tree (Node): tree to collect parents from
  • Child (Node): expected child node
    • default: any

source: src/parents.ts

PositionalInfo<[T]>

Object containing the positional information of tree T.

  • T (Node): tree to get positional information from

source: src/positional-info.ts

Test

Union of test types for a Node.

See unist-util-is for more details.

source: src/test.ts

TestFunction<[T][, P][, U]>

Check if a node passes a test.

fn(node[, index][, parent])

Parameters:

  • node (T): node to check
  • index (Index | undefined): index of node in parent.children
  • parent (Parent | undefined): parent of node

Returns:

boolean | undefined | void test result for node

source: src/test-function.ts

Type<[T]>

Extract type from tree T.

  • T (Node): tree to extract type from

source: src/type.ts

Uint

Number used for iteration.

Range: [0, 10]

source: src/uint.ts

Value<[T]>

Extract the value of tree T.

source: src/value.ts

Contribute

See CONTRIBUTING.md.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.