imterah/element-portable
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update AsyncStore's docs to be slightly more clear

Browse source
This commit is contained in:
Travis Ralston 2020-05-14 14:20:01 -06:00
parent b7ba9b3c41
commit 5cfe29de66
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/stores/AsyncStore.ts
View file

@ -29,9 +29,11 @@ export const UPDATE_EVENT = "update";
* of everything needing to happen in a dispatch cycle, everything can * of everything needing to happen in a dispatch cycle, everything can
* happen async to that cycle. * happen async to that cycle.
* *
* The store's core principle is Object.assign(), therefore it is recommended * The store operates by using Object.assign() to mutate state - it sends the
* to break out your state to be as safe as possible. The state mutations are * state objects (current and new) through the function onto a new empty
* also locked, preventing concurrent writes. * object. Because of this, it is recommended to break out your state to be as
* safe as possible. The state mutations are also locked, preventing concurrent
* writes.
* *
* All updates to the store happen on the UPDATE_EVENT event channel with the * All updates to the store happen on the UPDATE_EVENT event channel with the
* one argument being the instance of the store. * one argument being the instance of the store.