Package Exports

@mathquis/modelx-webstorage-connector
@mathquis/modelx-webstorage-connector/lib/es5/index.js
@mathquis/modelx-webstorage-connector/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mathquis/modelx-webstorage-connector) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Web storage connector for ModelX

⚠️ ModelX uses MobX v5 new Proxy feature. This feature is only supported by recent browsers https://caniuse.com/#feat=proxy

Installation

npm install -D @mathquis/modelx-webstorage-connector

Usage

The WebStorageConnector accepts a required storage option defining the underlying storage mechanism used to persist models. Both localStorage and sessionStorage are accepted. You can also use any storage that implements the Web storage API.

import {Model, Collection} from '@mathquis/modelx';
import WebStorageConnector from '@mathquis/modelx-localstorage-connector';

const localStorageConnector = new WebStorageConnector({storage: localStorage});

class User extends Model {
    static get path(): string {
        return '/users/{id}';
    }
    static get connector(): Connector {
        return localStorageConnector;
    }
}

// We create a new User model
const user = new User({
    id: 1,
    lastName: 'Doe',
    firstName: 'John'
});

user.save()
.then((model: Model) => {
    // My model is now created on the API
    return model.destroy();
})
.then((model: Model) => {
    // My model is now deleted from the API
});

const users = new Collection( User );

users.list().then((collection: Collection) => {
    console.log(collection.length);
});

Filtering

The WebStorageConnector supports filters in list() using MongoDB query selectors.

const col = new Collection( User );

// List only admin users created before 10/5/2018 at 5:43PM
col.list({
    filters: {
        type: {
            $eq: 'admin'
        },
        createdAt: {
            $lt: 1538747016000
        }
    }
});

Pagination

The WebStorageConnector supports pagination using the offset and limit options of the list() method.

const col = new Collection( User );

// List only admin users created before 10/5/2018 at 5:43PM
col.list({
    offset: 20,
    limit: 10
});

Generated model ID

If the model does not have an id when saving, the connector will generate one using the function provided in the id option. If no function is provided, a UUID (using the uuid module) will be generated.

let autoIncrement = 0;

const constructor = new WebStorageConnector({
    id: () => ++autoIncrement
});

const user = new User();

user.save(); // user.id will be be automatically set to 1

const user2 = new User();

user2.save(); // user2.id will be automatically set to 2

Encoder / Decoder

The WebStorageConnector accepts an encoder and a decoder options to use different serializers/unserializers to store models in web storage. By default, the connector uses JSON.stringify as encoder and JSON.parse as decoder.

const connector = new WebStorageConnector({
    encoder: (value: object) => msgpack.encode(value),
    decoder: (value: string) => msgpack.decode(value)
});

Prefixing

The WebStorageConnector accepts a prefix option to automatically prefix all keys in the web storage. This can help avoid collision between multiple instance of the connector.

const connector = new WebStorageConnector({
    prefix: '/namespace-a'
});