Add state persisting to @huds0n/shared-state using @react-native-async-storage/async-storage\r\n
\r\n\r\n\r\n\r\n## 📝 Table of Contents\r\n\r\n- [About](#about)\r\n- [Features](#features)\r\n- [Getting Started](#getting_started)\r\n- [Usage](#usage)\r\n - [Persisting a Shared State](#persist)\r\n- [Reference](#reference)\r\n - [Store Options](#reference_store-options)\r\n- [Authors](#authors)\r\n- [Acknowledgments](#acknowledgement)\r\n\r\n\r\n\r\n## 🧐 About \r\n\r\nAdd state persisting to **React Native** projects using the [@huds0n/shared-state](https://github.com/JontiHudson/modules-huds0n-shared-state) module.\r\n\r\n\r\n\r\n## ✅ List of Features \r\n\r\n- **Quick:** _Initialize a store in a single line._\r\n- **Secure:** _Built in AES encryption._\r\n- **Specific:** _Use include/exclude keys to specify which props to save._\r\n- **Automatic:** _Have state save on background or after change._\r\n\r\n\r\n\r\n## 🏁 Getting Started \r\n\r\n### **Prerequisites**\r\n\r\nRequires [huds0n/shared-state](https://github.com/JontiHudson/modules-huds0n-shared-state) and [@react-native-async-storage/async-storage](https://github.com/react-native-async-storage/async-storage).\r\n\r\n\r\n\r\n### **Installing**\r\n\r\n```\r\nnpm i @huds0n/shared-state-store-rn\r\n```\r\n\r\n\r\n\r\n## 🧑💻 Usage \r\n\r\n### **Persist a Shared State**\r\n\r\n```js\r\nimport { SharedState } from \"@huds0n/shared-state\";\r\n\r\nconst ExampleState = new SharedState({\r\n username: null,\r\n password: null\r\n ...ect\r\n});\r\n\r\nExampleState.initializeStorage(\r\n createStoreRN(storeOptions),\r\n);\r\n```\r\n\r\n_Returns a promise that resolve with true/false depending on success.See reference for [storeOptions](#reference_store_options)._\r\n\r\n\r\n\r\n## 📖 Reference \r\n\r\n### **Store Options**\r\n\r\n| Prop | Required/(_Default_) | Description | Type |\r\n| ----------------- | :------------------: | ---------------------------------------------------------------------------------------------- | -------------------------------------- |\r\n| encryptionKey | - | AES encryption stringStorage unencrypted if undefined | _string_ |\r\n| excludeKeys | - | List of state props not to save | array of _state keys_ |\r\n| includeKeys | - | List of state props to saveAll other state props skippedOverrides _excludeKeys_ prop | array of _state keys_ |\r\n| replacer | - | Replacer function used in stringifing the save state | (key: _string_, value: _any_) => _any_ |\r\n| reviver | - | Reviver function used in parse the save state | (key: _string_, value: _any_) => _any_ |\r\n| saveOnBackground | false | Saves state automatically when app is backgrounded | _boolean_ |\r\n| saveAutomatically | false | Saves state automatically whenever state changes | _boolean_ |\r\n| storeName | ✔ | name of store | _string_ |\r\n\r\n\r\n\r\n## ✍️ Authors \r\n\r\n- [@JontiHudson](https://github.com/JontiHudson) - Idea & Initial work\r\n- [@MartinHudson](https://github.com/martinhudson) - Support & Development\r\n\r\nSee also the list of [contributors](https://github.com/JontiHudson/modules-huds0n-shared-state-store-rn/contributors) who participated in this project.\r\n\r\n\r\n\r\n## 🎉 Acknowledgements \r\n\r\n- Special thanks to my fiance, Arma, who has been so patient with all my extra-curricular work.\r\n","readmeFilename":"README.md"}