react-native-global-state-hooks 6.0.0 → 6.0.1

package/README.md

@@ -32,6 +32,29 @@ return <Button onClick={() => setCount((count) => count + 1)}>{count}</Button>;
 
 Isn't it cool? It works just like a regular **useState**. Notice the only difference is that now you don't need to provide the initial value since this is a global hook, and the initial value has already been provided.
 
+# Using async persist storage
+
+Just add a key for the async storage
+
+```ts
+const useCountPersisted = createGlobalState(1, {
+  asyncStorage: {
+    key: "count",
+  },
+});
+```
+
+After this the metadata of the hooks will now include a flag which will help you to determinate if the async storage was already reached.
+
+```ts
+const [count, setCount, { isAsyncStorageReady }] = useCountPersisted();
+```
+
+If no key is provided, the default metadata is null. Otherwise, it's set to **{ isAsyncStorageReady: false }**.
+
+Upon the first successful retrieval from **AsyncStorage**, components will re-render with **{ isAsyncStorageReady: true }** in the metadata.
+The metadata and components will be updated and re-rendered even if there's no difference between the value stored in **AsyncStorage** and the store's default value. This is the only instance where the metadata forces a re-render, after this the metadata will not update the component
+
 # Selectors
 
 What if you already have a global state that you want to subscribe to, but you don't want your component to listen to all the changes of the state, only a small portion of it? Let's create a more complex **state**
@@ -469,6 +492,28 @@ In the example the hook will work the same and you'll have access to the correct
 
 # Extending Global Hooks
 
+## `[IMPORTANT!]`: From version 6.0.0, you can continue creating your custom implementations or using your previous ones. However, now AsyncStorage is already integrated into the global hooks with @react-native-async-storage/async-storage. You simply need to add a key for the persistent storage, and that will do the trick.
+
+```ts
+// this is all you need fo using async storage
+const useCountPersisted = createGlobalState(1, {
+  asyncStorage: {
+    key: "count",
+  },
+});
+
+/**
+ * Usage in your components:
+ * [NOTE]: If no key is provided, the default metadata is null. Otherwise, it's set to { isAsyncStorageReady: false }.
+ *
+ * Upon the first successful retrieval from AsyncStorage, components will re-render with { isAsyncStorageReady: true } in the metadata.
+ * The metadata and components will be updated and re-rendered even if there's no difference between the value stored in AsyncStorage and the store's default value. This is the only instance where the metadata forces a re-render, after this the metadata will not update the component
+ */
+const [count, setCount, { isAsyncStorageReady }] = useCountPersisted();
+```
+
+##### Now lets continue analizing how to create a custom GlobalStore!
+
 Creating a global hook that connects to an asyncStorage is made incredibly easy with the **createCustomGlobalState** function.
 
 This function returns a new global state builder wrapped with the desired custom implementation, allowing you to get creative! Le'ts see and example:

package/lib/src/GlobalStore.types.d.ts

@@ -49,7 +49,7 @@ export type StoreTools<TState = any, TMetadata = any, TActions = any> = Omit<Glo
  * @returns {ActionCollectionConfig<TState, TMetadata>} result - The action collection configuration
  */
 export interface ActionCollectionConfig<TState, TMetadata = null> {
-    [key: string]: (...parameters: any[]) => (storeTools: StoreTools<TState, TMetadata>) => unknown | void;
+    [key: string]: (...parameters: any[]) => (storeTools: any) => unknown | void;
 }
 /**
  * This is the actions object returned by the hook when you pass an storeActionsConfig configuration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-global-state-hooks",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "This is a package to easily handling global-state across your react-native-components No-redux... The library now includes @react-native-async-storage/async-storage to persist your state across sessions... if you want to keep using the old version without async-storage or react-native dependencies just use version 5.0.15 or user react-hooks-global-states instead",
   "main": "lib/bundle.js",
   "types": "lib/src/index.d.ts",