mobx-persist-store stable release

[quarrant]

Supports only mobx v6

API

• [ ] makeAutoPersist
• [ ] isSynchronized
• [ ] waitSynchronization
• [ ] forceSynchronize
• [ ] startPersist
• [ ] stopPersist
• [ ] clearStorage
• [ ] configure

New

• skip non observable properties for economy memory
• set global adapter for all stores (also can use local adapter)

[quarrant]

@codeBelt FYI

[codeBelt]

@quarrant is this a todo list for a v1.0.0 release?

[quarrant]

@codeBelt yep

[codeBelt]

@quarrant can you write more information on what these are:

• makeAutoPersist
• waitSynchronization
• forceSynchronize
• skip non observable properties for economy memory
• set global adapter for all stores (also can use local adapter)

[quarrant]

@codeBelt

• makeAutoPersist (like makeAutoObservable =)) - configure persist store with params: name, properties (uses annotations), storage (without StorageAdapter class) and reactionOptions
• waitSynchronization - promise that waiting when all processes in makeAutoPersist will be done
• forceSynchronize - trigger to load storage into store (issue #23)
• skipNonObservable - if set true non observable properties doesn't save to storage (memory economy)
• you can set storage options uses configure and it will be work for all stores, but also you can override them in makeAutoPersist

[codeBelt]

@quarrant Here is what I have so far. I had a little help from a friend on naming.

• makeAutoPersistable (todo by @quarrant)
• makePersistable

With Required Options:

import { makePersistable } from 'mobx-persist-store';

makePersistable(this, { name: 'myStore', properties: ['someProperty'], storage: window.localStorage });

With All Options:

import { configure } from 'mobx-persist-store';
import localForage from "localforage";
import ms from 'milliseconds';

makePersistable(
  this,
  {
    name: 'myStore',
    properties: ['someProperty'],
    storage: localForage,
    expireIn: ms.days(7),
    removeOnExpiration: false,
    stringify: false,
  },
  { delay: 200 }, // Optional
);

API

• clearPersistedStore
• hydrateStore
• isHydrated
• isPersisting
• pausePersisting
• startPersisting
• stopPersisting

Configuration

import { configure } from 'mobx-persist-store';
import localForage from "localforage";
import ms from 'milliseconds';

configure({
  storage: localForage, // localForage, window.localStorage, AsyncStorage all have the same interface
  expireIn: ms.days(7),
  removeOnExpiration: false,
  stringify: false,
  delay: 200,
});

...

// Only `name` and `properties` are needed for `makePersistable`
makePersistable(this, { name: 'myStore', properties: ['someProperty'] });

I would like to write tests for PersistStore.ts still before I hand it off to you. I hope to get that done next weekend.

[quarrant]

@codeBelt can we talk in telegram?

https://t.me/quarrant

[codeBelt]

@quarrant I sent you a LinkedIn request. Lets talk there

[codeBelt]

@quarrant I think I am finished with all my code changes and update the README. https://github.com/codeBelt/mobx-persist-store/tree/MobxStorePersist#readme

The only thing I will need to do is update the example demo.

[codeBelt]

@quarrant Do want to merge my code and get a Release Candidate 1.0.0-rc.0 tag out there? Then I can start woking on the example demo and have people start playing with it.

• https://semver.npmjs.com/

[quarrant]

@quarrant Do want to merge my code and get a Release Candidate 1.0.0-rc.0 tag out there? Then I can start woking on the example demo and have people start playing with it.

• https://semver.npmjs.com/

done

[codeBelt]

@quarrant what do you think of new code: https://codesandbox.io/s/mobx-persist-store-version-1-f852w?file=/src/stores/User.store.ts&theme=dark

Do you have anyone else to give us feedback on the new changes?

[codeBelt]

@quarrant Have you tried out 1.0.0-rc.0? Is it ready to be released as 1.0?

[quarrant]

@codeBelt yep! It's a great work! let's go =)

[codeBelt]

@quarrant I think you can close those 4 current issues since we have a 1.0 release.