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-jsonapi
Advanced tools
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.
datx-jsonapi
is a datx mixin that adds JSON API support.
import { Collection, Model, prop } from 'datx';
import { jsonapi } from 'datx-jsonapi';
import { computed } from 'mobx';
class Person extends jsonapi(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 jsonapi(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
await john.save(); // POST to the server
const people = await store.fetchAll(Person); // Get all people from the server
Note: datx-jsonapi
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-jsonapi 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:
How to add the polyfills. Note: Fetch API is not included in the polyfills mentioned in the Troubleshooting page. Instead, you need to add it as a separate library. If you don't have any special requirements (like server-side rendering), you can use the window.fetch polyfill.
Having issues with the library? Check out the troubleshooting page or open an issue.
The MIT License
datx-jsonapi is maintained and sponsored by Infinum.
FAQs
DatX mixin for JSON API support
We found that datx-jsonapi 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.