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-tmf-query

v1.2.1

Published

This library aims to provide a simple wrapper around jsonpath, to ease the implementation of TMF630 JSONPath specification as outlined by the TM Forum [here](https://projects.tmforum.org/wiki/pages/viewpage.action?spaceKey=PUB&title=TMF630+REST+API+Design

Downloads

95

Readme

JSONPath TMF Query

This library aims to provide a simple wrapper around jsonpath, to ease the implementation of TMF630 JSONPath specification as outlined by the TM Forum here

Usage

JSONPathQuery.query(document: any, query: Operation[]): any

Accepts a document and an array of query operations to be performed on the document. These operations all take a JSONPath query in the path parameter as outlined here, and have been identified in the TMF630 specification guidelines Part 6. These Operations are outlined below:

  1. Sort
  2. Filter
  3. Fields

Returns a mutated document or collection.

Note: these operations occur in the above mentioned order when combined

Operations

Sort { path: string, op: 'sort', order: 'asc' | 'desc'}

Filter { path: string, op: 'filter', limit?: number, offset?: number}

As filter allows for limit and offset, keep in mind that JSONPath also allows for similar functionality with array slices [x:y]. Combining both will likely return unintended results.

Fields { path: string, op: 'fields'}

When Fields is used, the id and href will always be returned. If fields is used on a collection, then the id and href must be included for all elements in the response.

Examples

For working examples of JSON Path Querying, look at the src/test/unit.test.ts file from the source repository. These test cases are taken from Part 6 of the TMF 630 specification.