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

repath

v0.1.5

Published

A utility for repathing normalized data using JavaScript getters

Downloads

9

Readme

repath Build Status Coverage Status npm version

A utility for repathing or denormalizing normalized data using JavaScript getters.

Installation

$ yarn add repath

Explanation

It's often preferred to store data in a flat map instead of nesting it, however it's hard to work with data in this format as all references need to be manually reconstructed, or the data needs to go through some kind of denormalization process. Repath leaves your data in a flat map but replaces all entity references with getter functions that return the expected data.

Repath only ever parses the top of the data tree, any nested processing that may be required is done when the getters are invoked to prevent any unnecessary work.

Example

import repath from 'repath'

const data = {
   users: {
      1: {
         name: "John",
         book: 1
      }
   },
   
   books: {
      1: {
         title: "Book A",
         author: 1
      }
   }
}

const join = repath({
   schemas: {
      users: {
         __keys: ["author"]
      },
      books: {
         __keys: ["book"]
      }
   }
})

const parsedData = join(data)
// parsedData
{
   users: {
      1: {
         name: "John",
         book: [getter]
      }
   },
      
   books: {
     1: {
        title: "Book A",
        author: [getter]
     }
  }
}

// parsedData.users[1].book
{
   title: "Book A",
   author: [getter]
}

API

repath(config): parser

Invoke repath with some initial config. This will return a parser function.

config = {
   schemas: {
      rootA: {
         __keys: ["a", "b"] // array of property keys that are references to 'root',
         ...overrides // key => root properties that override the __keys of other roots. 
      },
      rootB: {
         __keys: [],
         b: "rootC", // instead of mapping b to rootA, map b to rootC
         a: null // specifying an override with value 'null' prevents any relationship mapping from occurring.
      },
      rootC: {
         ...
      }
   },
   unions: ["c", "d"], // array of properties that are unions of other schemas,
   
   /* By default, repath expects unions to be referenced by an object: {schema, id}.
    * If your union does not follow this pattern, you can provide a function to
    * infer the reference.
    * */
   inferReference: union => ({schema: string, id: string | number})
}

parser(data [, limiter]): Object

This is a function that will replace entity references with getter functions.

  • data: Object - The collection of entities you want to parse
  • limiter: Array<string> | string - Either a root or an array of roots to exclusively parse. All other roots will be ignored

Credits

Repath was inspired by a conversation with Alexis Vincent and was built as a collaboration.