Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
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.
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
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:
npm install --save datx mobx
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:
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 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
classwithMeta
(model) - Adds some helpful meta data to the model - already included in the Model
class, but not in the PureModel
classwithPatches
(model, collection) - Adds patch support to models and collectionsdatx-jsonapi
(model, collection and view) - Adds the JSON API features to the model, collection and viewTo check out what are the planed future mixins, check out the issues.
Want to make your own mixin? Check out the guide.
Having issues with the library? Check out the troubleshooting page or open an issue.
Package | npm version | dependency status | dev dependency status |
---|---|---|---|
datx | |||
datx-jsonapi | |||
datx-utils |
The MIT License
datx is maintained and sponsored by Infinum.
FAQs
A MobX data store
The npm package datx receives a total of 43 weekly downloads. As such, datx popularity was classified as not popular.
We found that datx demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.