w33ble/react-mutable-store
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Compare commits

base: w33ble:159f1682300878a68b3459e8b3f9decf93bccb2d
Branches Tags
w33ble:master
..
compare: w33ble:c2ae065be74922091a8e3f1ae9061236dc75f1c5
Branches Tags
w33ble:master

1 Commits
159f168230 ... c2ae065be7

Author SHA1 Message Date
joe fleming
c2ae065be7 docs: add details to readme 2019-03-22 14:55:02 -07:00
1 changed files with 1 additions and 1 deletions
Expand all files Collapse all files

2
README.md
View File

@@ -41,7 +41,7 @@ A React component used to provide all of the created stores as context. You can
A React [hook](https://reactjs.org/docs/hooks-reference.html) to access the store's state value, and methods to read and update it. The hook returns an object with the following properties: A React [hook](https://reactjs.org/docs/hooks-reference.html) to access the store's state value, and methods to read and update it. The hook returns an object with the following properties:
Property | Description Property | Description
-- | -- -------- | -----------
`state` | The current state value of the store. `state` | The current state value of the store.
`commit(name, ...args)` | Executes mutations, which synchronously change the state and update context, causing components that use the context to re-render. `commit(name, ...args)` | Executes mutations, which synchronously change the state and update context, causing components that use the context to re-render.
`dispatch(name, ...args)` | Fires actions, which perform async work and use mutations to update state. Returns a Promise that resolves when the action is complete. `dispatch(name, ...args)` | Fires actions, which perform async work and use mutations to update state. Returns a Promise that resolves when the action is complete.