npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@simplej/mobx-model

v1.1.6

Published

A MobX Model class for easily wrapping nested JSON models in MobX observable classes.

Downloads

1

Readme

@simplej/mobx-model

A MobX Model class for easily wrapping nested JSON models in MobX observable classes.

Install

npm install @simplej/mobx-model

Example

import Model from '@simplej/mobx-model';

class User extends Model {
  static get schema() {
    return {
      id: Number,
      name: String,
      createdAt: Date,
      posts: [ Post ],
      bestFriend: User,
    };
  }
}

class Post extends Model {
  static get schema() {
    return {
      id: Number,
      title: String,
      content: String,
      createdAt: Date,
      author: User,
    };
  }
}

// optional: in case models need access to a parent or root store,
// you can pass it as the second argument to model constructors and `fromArray`
const store = {};

const user = new User({
  id: 1,
  name: 'Joe Schmoe',
  createdAt: '2018-08-20T18:43:37.504Z', // will be converted to a Date
  bestFriend: { // will be converted to a User instance
    id: 2,
    name: 'Sarah Spencer',
    createdAt: '2018-08-20T18:43:37.504Z',
  },
  posts: [ // will be converted to an array of Post instances
    {
      id: 10,
      title: 'Post title',
      content: 'Post content',
      createdAt: '2018-08-20T18:43:37.504Z'
    },
  ]
}, store);

user.patch({
  posts: [ // will be converted to an array of Post instances
    {
      id: 11,
      title: 'New post title',
      content: 'New post content',
      createdAt: '2018-08-20T18:43:37.504Z'
    },
  ]
});

API

Extend a model:

import Model from '@simplej/mobx-model`;
import Post from './Post';

class User extends Model {
  static get schema() {
    return {
      id: Number,
      age: Number,
      name: String,
      posts: [ Post ],
    };
  }
}

Create a new Model instance:

new Model(fields:Object?, store:Object?)

const model = new Model({ ... }, store);

Create an array of model instances:

Model.fromArray(models:Array, store:Object?)

const models = Model.fromArray([ ... ], store);

Patch a model:

Model#patch(fields:Object)

model.patch({ ... });

Custom deserializers

If you need to use custom deserializers in your schema, you can use an object with a deserialize method:


const Range = {
  deserialize(rangeString) {
    const [ min, max ] = rangeString.split('-');
    return [+min, +max];
  }
};

class MyModel extends Model {
  static get schema() {
    return {
      id: Number,
      myRange: Range,
    };
  }
}

const model = new MyModel({
  id: 1,
  myRange: '10-20' // will be automatically converted to [10, 20]
});

model.patch({
  myRange: '200-300' // will be automatically converted to [200, 300]
});