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

@breadhead/denormalize

v2.0.3

Published

Utility to save your complex data structures during normalization

Downloads

9

Readme

Denormalize

Utility to save your complex data structures during normalization

Currently works with:

Why?

Imagine yourself trying to send Dates or Options to the server and receiving it back. denormalize is aimed to help you with that by preparing your object to normalization and denormalization.

Example

  1. For example, you have objectToNormalize which you want to send to the server
import { Option } from "tsoption";


const objectToNormalize = {
  age: Option.of(42),
  expireAt: new Date()
};

Option during normalization is going to be converted to plain JS object with all metadata lost

  1. To save our precious data we need to prepare our object and add our metadata
import { prenormalize } from 'denormalize';


const prenormalized = prenormalize(objectToNormalize)

After prenormalizing object'll look like that

{
  age: {
    value: 42,
    OPTION_MARK: true
  },
  expireAt: new Date()
};
  1. Now it's time to send our object to the server

After serialization it'll look like that

const serialized =
  '{age:{value:42,OPTION_MARK:true},expireAt:"Wed Apr 10 2019 17:23:19 GMT+0300 (Moscow Standard Time)"}';
  1. Later we need to receive it from the server and deserialize

After deserialization it'll look like that

const deserialized = {
  age: {
    value: 42,
    OPTION_MARK: true
  },
  expireAt: 'Wed Apr 10 2019 17:23:19 GMT+0300 (Moscow Standard Time)'
};
  1. The final and the most important step: denormalization

Here we restore all precious metadata

import { denormalize } from 'denormalize';

const denoramlized = denormalize(deserialized)


const denormalized = {
  age: Option.of(42),
  expireAt: new Date()
};

Real world examples

Denormalizing data from the server


import { denormalize } from '@breadhead/denormalize'

export const fetchArticleRequest = (api: Api) => (
  id: number,
): Promise<ArticleModel> =>
  api.client
    .get('/articles')
    .then(response => denormalize(response.data) as ArticleModel[])
    .then(articles => articles.find(article => id === article.id))
    .then(article => {
      if (!article) {
        throw new Error(`Article with proided id (${id}) not found`)
      }

      return article
    })

Prenormalizing data


import { denormalize, prenormalize } from '@breadhead/denormalize'

export const getOrCreateStore = (initialState?: State) => {
  if (isServer) {
    prenormalize(initialState)
  }

  const state = denormalize(initialState)

  // Always make a new store if server, otherwise state is shared between requests
  if (isServer) {
    return initializeStore(state)
  }

  // Create store if unavailable on the client and set it on the window object
  // prettier-ignore
  if (!(window as any)[__NEXT_REDUX_STORE__]) {
    (window as any)[__NEXT_REDUX_STORE__] = initializeStore(state)
  }

  return (window as any)[__NEXT_REDUX_STORE__]
}