@js-entity-repos/memory

A concrete implementation of js-entity-repos for memory.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
138Jun 12, 2021Dec 22, 2017Minified + gzip package size for @js-entity-repos/memory in KB

Readme

memory

A concrete implementation of js-entity-repos for memory.

Usage

  1. Install it with npm i @js-entity-repos/memory.
  2. For each entity you will need to do the following.
    1. Create Entity interface.
    2. Construct the facade.
    3. Use the facade.

Entity Interface

import Entity from '@js-entity-repos/core/dist/types/Entity';

export interface TodoEntity extends Entity {
  readonly description: string;
  readonly completed: boolean;
}

Construct the Facade

import factory from '@js-entity-repos/memory/dist/factory';

interface State { todos: TodoEntity[]; }
const state: State = { todos: [] };

const todosFacade = factory({
  // Optional property. Defaults to 10.
  defaultPaginationLimit: 10,
  entityName: 'todo',
  // Optional property. Defaults to using entities stored locally in the factory.
  getEntities: () => state.todos,
  // Optional property. Defaults to using entities stored locally in the factory.
  setEntities: (todos) => state.todos = todos,
});

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.