IMM.js

Immutable data collections built on top of seamless-immutable

Seemless-immutable.js is great, but it doesn't have an API that feels right for CRUD applications. Imm wraps it to provide a convenient API for CRUD applications.

For example:

// add one record
list.add(record);

// add many records
list.add(records)

// get one record
list.get(id);

// update one record (patch)
list.update(record);

// remove one record
list.remove(ids);

// remove many records
list.remove(ids);

... many more

Install

Using NPM

npm install imm

Browser global

Download dist/imm.js or dist/imm.min.js

This library requires seamless-immutable to be loaded.

Usage

Create a list by:

var list = Imm.List(records);

See the API docs for all the methods available on List.

Create an object by:

var object = Imm.Obj(record);

Imm.Obj just delegates to Seamless Immutable. See https://github.com/rtfeldman/seamless-immutable#immutable-object

API docs

Development

To generate documentation verb needs to be installed:

npm i -g verb-cli

Testing

npm install
npm test

Build

This will lint, test, minify and create documentation

gulp

Related projects

• immutable.js
• seamless-immutable