npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

normalized-get

1.1.0 • Public • Published

Normalized Get

Helper functions for traversing normalizr relationships.

Who is this for?

Anyone that uses normalizr, or normalized data that conforms to it.

What does it do?

  1. NormalizedGet lets you access normalized data using a path as though it was denormalized.
  2. GraphGet lets you denormalize multiple paths at once, perfect for using in components.

NormalizedGet

Say you have a schema like this:

  const users = new schema.Entity('users');
  const comments = new schema.Entity('comments', {
    user: users
  });
  const articles = new schema.Entity('articles', {
    author: users,
    comments: [comments]
  });
  return { comments, articles, users };

Just setup bindNoramlizedGet like so:

const normalizedGet = bindNormalizedGet(schemas, data); 

Now you can access deep relationships with a single line of code:

// With normalizedGet
const commenters = normalizedGet('articles[123].comments.user');

It even follows Array entities. So the above example will map over the comments and return the authors.

For comparison, here's how you'd do it without normalizedGet:

// Without normlaizedGet:
const commenters = Object.keys(data.comments)
  .map(key => {
    const userId = data.comments[key].user
    return data.users[userId];
  });

The more relationships your data has have the more complex this manual fetching gets. And you have to remember which property maps to which model.

graphGet

normalizedGet is nice for getting a specific piece of data from your entity graph. What if you need more data? That's where graphGet comes in handy. It returns a deep structure containing the data you specify.

First we bind graphGet using the similar config method as before:

const graphGet = bindGraphGet(schemas, data); 

Now we can retrieve the commenters as before, but also the article and comments too.

const models = graphGet('articles[123].comments.user')

This will output nested data ready for use in a view:

{
  articles: {
    123: {
      title: '',
      comments: [{
        comment: 'Looks good to me', 
        user: { name: 'Jane' } 
      }, {}, {}]
    }
  }
}

GraphGet can accept multiple paths and merge them together.

graphGet(
  `articles[${articleId}].comments.user`,
  `users[${currentUserId}]`
)

Differences between graphGet and normalizedGet

Both functions use the same underlying recursive getter. Both map over array results. normalizedGet only returns the "leaf" data, the last element of the path. graphGet returns both the leaf and the data leading to it. normalizedGet works only on a single path and has no merge strategy. graphGet merges paths into an identity map at the root.

Usage

First bind your schemas. This makes it easy to use the getters without passing schemas and data in each time. Probably best to do this somewhere central in your project and export the bound getter.

export const normalizedGet = bindNormalizedGet(schemas, data);
export const graphGet = bindGraphGet(schemas, data);

Now you have normalizedGet and graphGet functions ready for easy data denormalization.

install

npm i normalized-get

Downloadsweekly downloads

7

version

1.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability