react-native-global-state-hooks 4.0.6 → 4.0.7

package/README.md

@@ -143,7 +143,7 @@ Additionally, to subscribe to state changes, you can pass a callback function as
  * This not only allows you to retrieve the current value of the state...
  * but also enables you to subscribe to any changes in the state or a portion of it
  */
-const removeSubscriptionGroup = contactsGetter(
+const removeSubscriptionGroup = contactsGetter<Subscribe>(
   ({ subscribe, subscribeSelector }) => {
     subscribe((state) => {
       console.log("state changed: ", state);

package/lib/GlobalStore.functions.d.ts

@@ -1,4 +1,4 @@
-import { ActionCollectionConfig, StateConfigCallbackParam, StateChangesParam, StateSetter, ActionCollectionResult, UseHookConfig, AvoidNever, GlobalStoreConfig, SubscriberCallback, UnsubscribeCallback } from "GlobalStore.types";
+import { ActionCollectionConfig, StateConfigCallbackParam, StateChangesParam, StateSetter, ActionCollectionResult, UseHookConfig, AvoidNever, GlobalStoreConfig, UnsubscribeCallback } from "GlobalStore.types";
 /**
  * Creates a global hook that can be used to access the state and actions across the application
  * @param {TState} state - The initial state
@@ -37,7 +37,31 @@ export declare const createGlobalStateWithDecoupledFuncs: <TState, TMetadata = n
      * @returns {boolean} result - true if you want to prevent the state change, false otherwise
      */
     computePreventStateChange?: (parameters: StateChangesParam<TState, TMetadata, TActions>) => boolean;
-}) => [useState: <State = TState>(selector?: (state: TState) => State, config?: UseHookConfig<State>) => [State extends null ? TState : State, TActions extends StateSetter<TState> ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>, TMetadata], getter: <TCallback extends SubscriberCallback<TState> = null>(callback?: TCallback) => TCallback extends null ? TState : UnsubscribeCallback, setter: TActions extends null ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>];
+}) => [useState: <State = TState>(selector?: (state: TState) => State, config?: UseHookConfig<State>) => [State extends null ? TState : State, TActions extends StateSetter<TState> ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>, TMetadata], getter: <Subscription extends boolean = false>(callback?: Subscription extends true ? ({ state, subscribe, subscribeSelector, }: {
+    state: TState;
+    subscribe: (callback: (state: TState) => void, config?: {
+        /**
+         * The callback to execute when the state is changed to check if the same really changed
+         * If the function is not provided the derived state will perform a shallow comparison
+         */
+        isEqual?: (current: TState, next: TState) => boolean;
+        /**
+         * By default the callback is executed immediately after the subscription
+         */
+        skipFirst?: boolean;
+    }) => void;
+    subscribeSelector: <TDerivate>(selector: (state: TState) => TDerivate, callback: (state: TDerivate) => void, config?: {
+        /**
+         * The callback to execute when the state is changed to check if the same really changed
+         * If the function is not provided the derived state will perform a shallow comparison
+         */
+        isEqual?: (current: TDerivate, next: TDerivate) => boolean;
+        /**
+         * By default the callback is executed immediately after the subscription
+         */
+        skipFirst?: boolean;
+    }) => void;
+}) => void : null) => Subscription extends false ? TState : UnsubscribeCallback, setter: TActions extends null ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>];
 /**
  * Creates a global hook that can be used to access the state and actions across the application
  * @param {TState} state - The initial state of the store
@@ -102,7 +126,31 @@ export declare const createCustomGlobalStateWithDecoupledFuncs: <TInheritMetadat
     onStateChanged?: (parameters: StateChangesParam<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>) => void;
     onSubscribed?: (parameters: StateConfigCallbackParam<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>) => void;
     computePreventStateChange?: (parameters: StateChangesParam<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>) => boolean;
-}) => [useState: <State = TState>(selector?: (state: TState) => State, config?: UseHookConfig<State>) => [State extends null ? TState : State, TActions extends null ? StateSetter<TState> : ActionCollectionResult<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>], getter: <TCallback extends SubscriberCallback<TState> = null>(callback?: TCallback) => TCallback extends null ? TState : UnsubscribeCallback, setter: TActions extends null ? StateSetter<TState> : ActionCollectionResult<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>];
+}) => [useState: <State = TState>(selector?: (state: TState) => State, config?: UseHookConfig<State>) => [State extends null ? TState : State, TActions extends null ? StateSetter<TState> : ActionCollectionResult<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>], getter: <Subscription extends boolean = false>(callback?: Subscription extends true ? ({ state, subscribe, subscribeSelector, }: {
+    state: TState;
+    subscribe: (callback: (state: TState) => void, config?: {
+        /**
+         * The callback to execute when the state is changed to check if the same really changed
+         * If the function is not provided the derived state will perform a shallow comparison
+         */
+        isEqual?: (current: TState, next: TState) => boolean;
+        /**
+         * By default the callback is executed immediately after the subscription
+         */
+        skipFirst?: boolean;
+    }) => void;
+    subscribeSelector: <TDerivate>(selector: (state: TState) => TDerivate, callback: (state: TDerivate) => void, config?: {
+        /**
+         * The callback to execute when the state is changed to check if the same really changed
+         * If the function is not provided the derived state will perform a shallow comparison
+         */
+        isEqual?: (current: TDerivate, next: TDerivate) => boolean;
+        /**
+         * By default the callback is executed immediately after the subscription
+         */
+        skipFirst?: boolean;
+    }) => void;
+}) => void : null) => Subscription extends false ? TState : UnsubscribeCallback, setter: TActions extends null ? StateSetter<TState> : ActionCollectionResult<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>];
 /**
  * @description
  * Use this function to create a custom global store.

package/lib/GlobalStore.types.d.ts

@@ -288,9 +288,13 @@ export type SubscriberCallback<TState> = ({ subscribe, }: {
  * if you don't pass a callback function the hook will return the current state of the store
  * @returns {UnsubscribeCallback | TState} result - the state or the unsubscribe callback if you pass a callback function
  */
-export type StateGetter<TState> = <TCallback extends SubscriberCallback<TState> | null = null>(
+export type StateGetter<TState> = <Subscription extends Subscribe | false = false>(
 /**
  * @param {SubscriberCallback<TState> | null} callback - the callback function to subscribe to the store changes (optional)
  * use the methods subscribe and subscribeSelect to subscribe to the store changes
  */
-callback?: TCallback) => TCallback extends null | never | undefined ? TState : UnsubscribeCallback;
+callback?: Subscription extends Subscribe ? SubscriberCallback<TState> : null) => Subscription extends Subscribe ? UnsubscribeCallback : TState;
+/**
+ * Constant value type to indicate that the getter is a subscription
+ */
+export type Subscribe = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-global-state-hooks",
-  "version": "4.0.6",
+  "version": "4.0.7",
   "description": "This is a package to easily handling global-state across your react-native-components No-redux",
   "main": "lib/bundle.js",
   "types": "lib/index.d.ts",