# datx > A MobX data store Latest version **1.1.4** (published 2022-05-12) · MIT license · 0 weekly downloads ## Install ```sh npm install datx pnpm add datx yarn add datx bun add datx ``` ## Health **Score 40/100 (D)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned. ## Facts | | | |---|---| | Version | 1.1.4 | | Published | 2022-05-12 | | First published | 2017-12-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 173.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 146 | | Author | Infinum JavaScript Team | | Maintainers | buhin, adrianbicanic, darkokukovec, nives, ivicabatinic, safo6m, fvoska, kbambir | ## Links - npm: https://www.npmjs.com/package/datx - Repository: https://github.com/infinum/datx - Homepage: https://github.com/infinum/datx#readme - Issues: https://github.com/infinum/datx/issues - npm.io page: https://npm.io/package/datx ## Dependencies (1) - [datx-utils](https://npm.io/package/datx-utils.md) ^1.1.0 ## Recent versions - 1.1.4 (latest) — 2022-05-12 - 2.0.0-beta.12 (beta) — 2020-11-22 - 0.0.1 (alpha) — 2017-12-26 - 1.1.3 — 2021-05-04 - 1.1.2 — 2021-03-25 - 1.1.0 — 2021-03-12 - 2.0.3 — 2021-01-26 - 2.0.2 — 2021-01-26 - 2.0.1 — 2021-01-23 - 2.0.0-beta.10 — 2020-11-21 - 2.0.0-beta.9 — 2020-11-20 - 2.0.0-beta.8 — 2020-11-11 - 2.0.0-beta.7 — 2020-10-05 - 2.0.0-beta.6 — 2020-09-26 - 2.0.0-beta.5 — 2020-09-26 - … 52 more at https://npm.io/package/datx/versions ## README # datx [![Greenkeeper badge](https://badges.greenkeeper.io/infinum/datx.svg)](https://greenkeeper.io/) DatX is an opinionated data store for use with the [MobX](https://mobx.js.org/) state management library. It features support for simple observable property definition, references to other models and first-class TypeScript support. *** ## Basic usage ```typescript import { Collection, Model, prop } 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@^4.2.0` or `mobx@^5.5.0`, so don't forget to install the latest MobX version: ```bash npm install --save datx mobx ``` * [Installation](https://datx.dev/docs/getting-started/installation) * [Defining models](https://datx.dev/docs/getting-started/defining-models) * [References](https://datx.dev/docs/getting-started/references) * [Configuring the collection](https://datx.dev/docs/getting-started/configuring-the-collection) * [Using the collection](https://datx.dev/docs/getting-started/using-the-collection) * [Persisting data locally](https://datx.dev/docs/getting-started/persisting-data-locally) ### Polyfilling The lib makes use of the following features that are not yet available everywhere. Based on your browser support, you might want to polyfill them: * [Symbol.for](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) * [Object.assign](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) * [Array.prototype.find](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find) [How to add the polyfills](https://datx.dev/docs/troubleshooting/known-issues#the-library-doesnt-work-in-internet-explorer-11). ## Concepts The library contains two main classes - [`Model`](https://datx.dev/docs/api-reference/model) and [`Collection`](https://datx.dev/docs/api-reference/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](https://datx.dev/docs/mixins/with-actions) and [properties](https://datx.dev/docs/mixins/with-meta), but if they're in collision with your data/logic, you can use a [`PureModel`](https://datx.dev/docs/api-reference/pure-model) class. ## Mixins Mixins are additional plugins that can enhance the regular models and collections. Available mixins: * [`withActions`](https://datx.dev/docs/mixins/with-actions) (model) - Adds some helper methods to the model - already included in the `Model` class, but not in the `PureModel` class * [`withMeta`](https://datx.dev/docs/mixins/with-meta) (model) - Adds some helpful meta data to the model - already included in the `Model` class, but not in the `PureModel` class * [`withPatches`](https://datx.dev/docs/mixins/with-patches) (model, collection) - Adds patch support to models and collections * [`datx-jsonapi`](https://datx.dev/docs/mixins/jsonapi-mixin) (model, collection and view) - Adds the [JSON API](https://jsonapi.org/) features to the model, collection and view To check out what are the planed future mixins, check out [the issues](https://github.com/infinum/datx/labels/mixins). Want to make your own mixin? Check out [the guide](https://datx.dev/docs/mixins/building-your-own-mixin). ## API reference * [Collection](https://datx.dev/docs/api-reference/collection) * [Model](https://datx.dev/docs/api-reference/model) * [View](https://datx.dev/docs/api-reference/view) * [prop](https://datx.dev/docs/api-reference/prop) * [PureModel](https://datx.dev/docs/api-reference/pure-model) * [CompatModel](https://datx.dev/docs/migration-guide/compat-model) * [CompatCollection](https://datx.dev/docs/migration-guide/compat-collection) * [Model utils](https://datx.dev/docs/api-reference/model-utils) * [Lib utils](https://datx.dev/docs/api-reference/lib-utils) * [TypeScript interfaces](https://datx.dev/docs/api-reference/typescript-interfaces) ## Troubleshooting Having issues with the library? Check out the [troubleshooting](https://datx.dev/docs/troubleshooting/known-issues) page or [open](https://github.com/infinum/datx/issues/new) an issue. *** [![Build Status](https://travis-ci.org/infinum/datx.svg?branch=master)](https://travis-ci.org/infinum/datx) | Package | npm version | dependency status | dev dependency status | | ------------ | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | datx | [![npm version](https://badge.fury.io/js/datx.svg)](https://badge.fury.io/js/datx) | [![Dependency Status](https://david-dm.org/infinum/datx.svg?path=packages/datx)](https://david-dm.org/infinum/datx?path=packages/datx) | [![devDependency Status](https://david-dm.org/infinum/datx/dev-status.svg?path=packages/datx)](https://david-dm.org/infinum/datx?path=packages/datx#info=devDependencies) | | datx-jsonapi | [![npm version](https://badge.fury.io/js/datx-jsonapi.svg)](https://badge.fury.io/js/datx-jsonapi) | [![Dependency Status](https://david-dm.org/infinum/datx.svg?path=packages/datx-jsonapi)](https://david-dm.org/infinum/datx?path=packages/datx-jsonapi) | [![devDependency Status](https://david-dm.org/infinum/datx/dev-status.svg?path=packages/datx-jsonapi)](https://david-dm.org/infinum/datx?path=packages/datx-jsonapi#info=devDependencies) | | datx-utils | [![npm version](https://badge.fury.io/js/datx-utils.svg)](https://badge.fury.io/js/datx-utils) | [![Dependency Status](https://david-dm.org/infinum/datx.svg?path=packages/datx-utils)](https://david-dm.org/infinum/datx?path=packages/datx-utils) | [![devDependency Status](https://david-dm.org/infinum/datx/dev-status.svg?path=packages/datx-utils)](https://david-dm.org/infinum/datx?path=packages/datx-utils#info=devDependencies) | ## License The [MIT License](LICENSE) ## Credits datx is maintained and sponsored by [Infinum](https://www.infinum.co). --- _Source: https://npm.io/package/datx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._