README.md
# mobx-collection-store
Structured data store for MobX. Partially influenced by [Backbone Collections](http://backbonejs.org/#Collection).
## Deprecation and migration
`mobx-jsonapi-store` and `mobx-collection-store` are deprecated in favor of [`datx`](https://github.com/infinum/datx) - it follows the same concepts, but adds support for MobX 4 and 5, better TypeScript support and more extensibility.
If you're new to the libraries, check out the datx [examples](https://github.com/infinum/datx/tree/master/examples) and [docs](https://github.com/infinum/datx/wiki).
If you already use `mobx-collection-store`, check out the [migration guide](https://github.com/infinum/datx/wiki/Migration-from-mobx-collection-store).
-------
**Using [JSON API](http://jsonapi.org/)?** Check out [mobx-jsonapi-store](https://github.com/infinum/mobx-jsonapi-store) - All mobx-collection-store features, and JSON API helpers in one place.
**Can be used with [Redux DevTools](https://github.com/infinum/mobx-collection-store/wiki/Redux-DevTools).**
***
[](https://travis-ci.org/infinum/mobx-collection-store)
[](https://codeclimate.com/github/infinum/mobx-collection-store/coverage)
[](https://badge.fury.io/js/mobx-collection-store)
[](https://david-dm.org/infinum/mobx-collection-store)
[](https://david-dm.org/infinum/mobx-collection-store#info=devDependencies)
[](https://greenkeeper.io/)
## Basic usage
```javascript
import {Collection} from 'mobx-collection-store';
const collection = new Collection();
const john = collection.add({
id: 1,
firstName: 'John',
lastName: 'Doe'
});
const jane = collection.add({
id: 2,
firstName: 'Jane',
lastName: 'Doe'
});
console.log(collection.length); // 2
john.lastName = 'Williams';
console.log(john.lastName); // 'Williams'
```
For more advanced use-cases, check out the [getting started](https://github.com/infinum/mobx-collection-store/wiki/Getting-started) guide, or the [examples](examples) folder.
## Installation
To install, use `npm` or `yarn`. The lib has a peer dependency of `mobx` 2.7.0 or later (including MobX 3).
```bash
npm install mobx-collection-store mobx --save
```
```bash
yarn add mobx-collection-store mobx
```
Since the lib is exposed as a set of CommonJS modules, you'll need something like [webpack](https://webpack.js.org/) or browserify in order to use it in the browser.
Don't forget to [prepare your code for production](https://webpack.js.org/guides/production/) for better performance!
## Getting started
The main idea behind the library is to have one instance of the collection that contains multiple model types. This way, there can be references between models that can handle all use cases, including circular dependencies.
* [Installation](https://github.com/infinum/mobx-collection-store/wiki/Installation)
* [Defining models](https://github.com/infinum/mobx-collection-store/wiki/Defining-models)
* [References](https://github.com/infinum/mobx-collection-store/wiki/References)
* [Configuring the collection](https://github.com/infinum/mobx-collection-store/wiki/Configuring-the-collection)
* [Using the collection](https://github.com/infinum/mobx-collection-store/wiki/Using-the-collection)
* [Persisting data locally](https://github.com/infinum/mobx-collection-store/wiki/Persisting-data-locally)
* [Redux DevTools](https://github.com/infinum/mobx-collection-store/wiki/Redux-DevTools)
## API reference
The library contains the following elements:
* [Collection](https://github.com/infinum/mobx-collection-store/wiki/Collection)
* [Model](https://github.com/infinum/mobx-collection-store/wiki/Model)
* [TypeScript interfaces](https://github.com/infinum/mobx-collection-store/wiki/Interfaces)
## License
The [MIT License](LICENSE)
## Credits
mobx-collection-store is maintained and sponsored by
[Infinum](http://www.infinum.co).
<img src="https://infinum.co/infinum.png" width="264">