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

fetch-normalize-data

v1.22.7

Published

A library to obtain a state of normalized data. Special fetch and reducer helpers are also provided in the export.

Downloads

45

Readme

A library to obtain a state of normalized data. Special fetch and reducer helpers are also provided in the export.

An implementation with a redux-thunk context is here, there for redux-saga. You can see also a poc with only a React Context (redux free) at this. Also, see this post for a presentation based on the pass culture project.

CircleCI npm version

Basic Usage

Merge

If you want to merge patched data into an already existing state:

import { getNormalizedMergedState } from 'fetch-normalize-data'

const state = {
  authors: [{ id: 0, name: "John Marxou" }],
  books: [{ authorId: 0, id: 0, text: "my foo" }]
}

const patch = {
  books: [
    {
      author: { id: 1, name: "Edmond Frostan" },
      id: 1,
      text: "you foo"
    }
  ]
}

const config = {
  normalizer: {
    books: {
      normalizer: {
        // short syntax here: <datumKey>: <stateKey>
        author: "authors"
      },
      stateKey: "books"
    }
  }
}

const nextState = getNormalizedMergedState(state, patch, config)

console.log(nextState)

We have:

{
  authors: [
    { id: 0, name: "John Marxou" },
    { id: 1, name: "Edmond Frostan" }
  ],
  books: [
    { authorId: 0, id: 0, text: "my foo" },
    {
      authorId: 1,
      id: 1,
      text: "you foo"
    }
  ]
}

Delete

import { getNormalizedDeletedState } from 'fetch-normalize-data'

const state = {
  authors: [{ id: 0, name: "John Marxou" }],
  books: [{ authorId: 0, id: 0, text: "my foo" }]
}

const patch = {
  books: [{ id: 1 }]
}

const nextState = getNormalizedDeletedState(state, patch, config)

console.log(nextState)

We have:

{
  authors: [
    { id: 0, name: "John Marxou" }
  ],
  books: []
}

Usage with config

config of getNormalizedMergedState can have:

| name | type | example | isRequired | default | description | | -- | -- | -- | -- | -- | -- | | isMergingArray | bool | See test | non | true | decide if nextState. will be a merge of previous and next data or just a replace with the new array | | isMergingDatum | bool | See test | non | false | decide if nextState.<arrayName>[...<datum>] will be a merge from previous and next datum or just a replace with next datum | | isMutatingArray | bool | See test | non | true | decide if nextState. will be a concat or a merge from previous array | | isMutatingDatum | bool | See test | non | false | decide if nextState.<arrayName>[...<datum>] will be a clone or a merge into the previous datum | | normalizer | objet | See test | non | null | a nested object giving relationships between datumKeys and entities to be store at stateKeys |

Fetch usage

fetchData

| name | type | example | isRequired | default | description | | -- | -- | -- | -- | -- | -- | | apiPath | string | /foos | no | undefined | apiPath will be join with rootUrl to build the request url | | handleFail | function(state, action) | TBP | no | undefined | callback called if request has failed | | handleSuccess | function(state, action) | TBP | no | undefined | callback called if request is a success | | method | STRING | POST | no | 'GET' | http method for the request | | stateKey | string | foos | no | <computed from apiPath or url> | key into the store.getState().data.<stateKey> where normalized merged or deleted data will be applied | | url | string | https://momarx.com/foos | no | undefined | total url of the request that will be used if apiPath is not used |

Reducer usage

fetch-normalize-data can play mainly with 3 types of actions:

  • REQUEST_DATA_(DELETE|GET|POST|PUT|PATCH)_(.*)
  • SUCCESS_DATA_(DELETE|GET|POST|PUT|PATCH)_(.*)
  • FAIL_DATA_(DELETE|GET|POST|PUT|PATCH)_(.*)

The action creator requestData is almost the only one you will need to use for fetching data at mount time or at event mutation time.

requestData

You can play with actions, but you need a special installation given the async action handler you take in your app:

See for example an example with https://github.com/betagouv/redux-thunk-data, but global use is like:

import { requestData } from 'fetch-normalize-data'

const config = {
  apiPath: '/foos',
  normalizer: {
    'bar': {
      stateKey: 'bars'
    }
  }
}

store.dispatch(requestData(config))

where config is all the possible config parameters you can find in config of getNormalizedMergedState or in the config of fetchData.