datx

datx

DatX is an opinionated data store for use with the MobX state management library. It features support for simple observable property definition, references to other models and first-class TypeScript support.

The library is still work in progress, but it's feature complete. You can track the v1.0 status using the v1.0 milestone.

---

Basic usage

import { Collection, Model, props } from 'datx';
import { computed } from 'mobx';

class Person extends Model {
  public static type = 'person'; // Unique name of the model class

  @prop name: string; // A normal observable property without a default value
  @prop surname: string;
  @prop.toOne(Person) spouse?: Person; // A reference to a Person model

  @computed get fullName() { // Standard MobX computed props
    return `${this.name} ${this.surname}`;
  }
}

class AppData extends Collection {
  public static types = [Person]; // A list of models available in the collection
}

const store = new AppData();
const john = store.add(new Person({name: 'John', surname: 'Smith'})); // Add a model instance to the store
const jane = store.add({name: 'Jane', surname: 'Smith', spouse: john}, Person); // Add a model to the store

Getting started

Note: datx has a peer dependency to mobx@^3.5.1, so don't forget to install the latest MobX version:

npm install --save datx mobx

• Installation
• Defining models
• References
• Configuring the collection
• Using the collection
• Persisting data locally

Concepts

The library contains two main classes - Model and Collection.

A collection contains models of any kind (they should however be listed in the types property), while a model can be in a single collection (but doesn't need to be in any).

Models also include some useful methods and properties, but if they're in collision with your data/logic, you can use a PureModel class.

Mixins

Mixins are additional plugins that can enhance the regular models and collections. Available mixins:

• withActions (model) - Adds some helper methods to the model - already included in the Model class, but not in the PureModel class
• withMeta (model) - Adds some helpful meta data to the model - already included in the Model class, but not in the PureModel class
• datx-jsonapi (model and collection) - Adds the JSON API features to the model and collection

To check out what are the planed future mixins, check out the issues.

Want to make your own mixin? Check out the guide.

API reference

• Collection
• Model
• prop
• PureModel
• CompatModel
• CompatCollection
• Model utils
• Lib utils
• TypeScript interfaces

---

Package	npm version	dependency status	dev dependency status
datx
datx-jsonapi
datx-utils

License

The MIT License

Credits

datx is maintained and sponsored by Infinum.