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

parse-json-path

v1.0.1

Published

Slice a string at characters `.` - `[` - and `]` - but not '\\.'

Downloads

4

Readme

✂️ parse-json-path

Slice a string at characters . - [ - and ] - but not '\\.'

npm License: MIT

Features

  • Handles '.' in key name by prepending a '\\' to it.
    • For example keyFoo.keyBar.key\\.Baz
  • Returns fully numeric keys as integer values representing an array index.
  • Handles numeric and escaped-dot tokens at combination within key names.

Motivation

In a whole handful of minutes I didn't come across something that did the specific thing. Also, I think having type declarations is pretty handy, even for projects not utilizing typescript, so I became the change I wanted to see in the world. 🌈

About

A majority of the module is a RegExp pattern:

/((.\\\.|[^[\].])*).(?=\.|\n|\r|$)/g

The array of matched substrings are then matched against a simpler pattern - /[0-9]+/gu - if there is a singlular match of the whole string, parseInt provides the value of that element. This accounts for puzzing yet possible scenarios where keys of a JSON file are something like --

  {
    "0.0": "value",
    "1.0": "value"
  }

-- which is valid JSON according to the spec.

Install

  • yarn add parse-json-path
  • npm i parse-json-path

Module use

CommonJS module

const parseJsonPath = require('parse-json-path')

/* ... */

parseJsonPath(someString)

ES2017

import { parseJsonPath } from 'parse-json-path'

/* ... */

parseJsonPath(someString)

API

parseJsonPath(string[, boolean])

| Parameter | Type | |---|---| | path | string | | silentFail | undefined | boolean |

In the case that the value to be parsed is:

  • Not a string
  • Without matches against the first regex

The function accepts an optional second argument - silentFail?: boolean. If truthy, the above scenarios result in a return value of undefined, rather than throwing an Error. Results can then be handled as needed.


Sample of inputs the resuturned JSON selectors

>> Test report and samples last generated on 2019-11-23T06:31:34.516Z

parseJsonPath('key1.easy')
//=> [ 'key1', 'easy' ]
parseJsonPath('key1.dot\\.key.1')
//=> [ 'key1', 'dot.key', 1 ]
parseJsonPath('key1.dot\\.key.3.array4key.nested')
//=> [ 'key1', 'dot.key', 3, 'array4key', 'nested' ]
parseJsonPath('0\\.sneakyKey')
//=> [ '0.sneakyKey' ]
parseJsonPath('0.0\\.sneakyKey')
//=> [ 0, '0.sneakyKey' ]

Test Output



  √ Parse key path: key1.easy
  √ Parse key path: key1.dot\.key.1
  √ Parse key path: key1.dot\.key.3.array4key.nested
  √ Parse key path: 0\.sneakyKey
  √ Parse key path: 0.0\.sneakyKey

  5 tests passed

Dependencies: 0


Suggestions, PRs, issue reports are welcome.

Author

👤 Cam Smith

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Cam Smith.

This project is MIT licensed.