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

jsonpath-ts

v0.1.1

Published

![](https://img.shields.io/npm/v/jsonpath-ts) ![](https://img.shields.io/bundlejs/size/jsonpath-ts)

Downloads

118

Readme

JSONPath Typescript

Type inference for JSONPath queries, as per the JSONPath query expressions RFC (see limitations below).

npm i jsonpath-ts

Usage

import { Parse } from "jsonpath-ts";

type Result = Parse<"$.store.book[*].author[2:6]", Data>;
//	 ^? ["Herman Melville", "J. R. R. Tolkien"]

// Given input type
export type Data = {
  store: {
    book: [
      {
        category: "reference";
        author: "Nigel Rees";
        title: "Sayings of the Century";
        price: 8.95;
      },
      {
        category: "fiction";
        author: "Evelyn Waugh";
        title: "Sword of Honour";
        price: 12.99;
      },
      {
        category: "fiction";
        author: "Herman Melville";
        title: "Moby Dick";
        isbn: "0-553-21311-3";
        price: 8.99;
      },
      {
        category: "fiction";
        author: "J. R. R. Tolkien";
        title: "The Lord of the Rings";
        isbn: "0-395-19395-8";
        price: 22.99;
      }
    ];
    bicycle: {
      color: "red";
      price: 399;
    };
  };
};

Limitations

  • Slice steps not supported (::-1)
  • Filtering not supported ([email protected])
  • Descendant segments not supported ($...X)

How does it work?

This implementation first converts the input path into an abstract, shallow ordered tree of Selectors, such as NameSelector, IndexSelector etc. This representation is then iterated over to retrieve the derive the correct type from the data.

This functionality can be imported independently via:

import {
	ParsePath, // Input path -> ParsedPath
	ExtractValue // ParsedPath -> Return data type
} from "jsonpath-ts