Giter Club home page Giter Club logo

flux-entity's Introduction

flux-entity

Utility library for the flux entity pattern

CircleCI npm version npm downloads code style: prettier


Motivation

A common pattern when working with a flux-based system such as Redux is to use a normalized registry of objects, keyed by some unique value.

Installation

With npm

npm install --save flux-entity

With yarn

yarn add flux-entity

API

// Returns a function for creating entities
createEntityFactory()

// Inserts values into an array
insertIntoArray(array, ...values)

// Removes values from an array
removeFromArray(array, ...values)

// Removes all values from an entity
clearEntity(entity)

// Returns a copy of the entity with all values
copyEntity(entity)

// Inserts values into an entity
insertIntoEntity(entity, ...values)

// Removes values from an entity
removeFromEntity(entity, ...values)

// Removes values from an entity by their id
removeFromEntityById(entity, ...ids)

Examples

Say we have an object type Person.

interface Person {
  id: number
  name: string
}

Create an entity factory for type Person. By supplying Person, we can get excellent type safety with Typescript.

const createEntity = createEntityFactory<Person>()

Create an entity, keyed by id. This will now mean that each Person is indexed with their id as the uniqueness qualifier.

const entity = createEntity('id')

We now have an empty entity.

{
  key: 'id', // Unique key
  ids: [], // Ordered array of all ids
  all: {}, // Dictionary with all objects
}

Insert a value into the entity.

insertIntoEntity(entity, {
  id: 0,
  name: 'Jane',
})

The resulting entity state now looks like this.

{
  key: 'id',
  ids: [0],
  all: {
    0: {
      id: 0,
      name: 'Jane',
    },
  },
}

flux-entity's People

Contributors

dependabot[bot] avatar glinkis avatar victorglindaspaf avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.