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

@finnair/path-parser

v7.0.0-alpha.8

Published

Simple object path as array of strings and numbers

Downloads

1,116

Readme

Path Parser

@finnair/path-parser contains nearley.js based parsers for Path and PathMatcher.

See @finnair/path or instructions on how to use Path and PathMatcher.

Getting Started

Install v-validation using yarn:

yarn add @finnair/path-parser

Or npm:

npm install @finnair/path-parser

Parsing Paths

import { parsePath } from '@finnair/path-parser';

parsePath(`$.array[1]["\\"property\\" with spaces and 'quotes'"]`); // JSON string encoded in brackets!
// Path.of('array', 1, `"property" with spaces and 'quotes'`);

// Single quotes also work, but encoding is still JSON string so the value cannot contain ' character
parsePath(`$['single quotes']`); // Path.of('single quotes')
parsePath(`$['single\'quote']`); // Fail!

// ...without using unicode escape
parsePath(`$['\\u0027']`); // Path.of("'");

Parsing PathMatchers

parsePathMatcher parses simple JsonPath like expressions. Supported expressions are

| Expression | Description  | | ----------------------------------- | --------------------------------------------------------------------- | | $.property | Identifiers matching RegExp /^[a-zA-Z_][a-zA-Z0-9_]*$/ | | $[0] | Index match | | $.* | Any property matcher, wildcard (matches also array indexes) | | $[*] | Any index matcher, wildcard (matches only array indexes) | | $["JSON string encoded property"] | Property as JSON encoded string | | $['JSON string encoded property'] | Property as single quoted, but otherwise JSON encoded, string(*) | | $[union,"of",4,'components'] | Union matcher that also supports identifiers and JSON encoded strings |

*) This is the official way of JsonPath, but the specification is a bit unclear on the encoding. In this library we prefer proper JSON string encoding with double quotes.

import { parsePathMatcher } from '@finnair/path-parser';

parsePathMatcher(`$.array[0][*].*['union',"of",properties,1]`);
// PathMatcher.of(
//   'array',
//    0,
//   AnyIndex,
//   AnyProperty,
//   UnionMatcher.of('union', 'of', 'properties', 1)
// )