react-state-monad 1.0.15 → 1.0.17

package/README.md

@@ -134,6 +134,22 @@ Parameters:
 Returns an array of new `StateObject`s, each representing an element in the original array. This allows individual
 updates while keeping the array state synchronized. If the state has no value, it returns an empty array.
 
+
+### `useNullSafety<TOrigin>`
+
+This hook ensures a `StateObject` contains a defined, non-null value. If the `StateObject`'s value is `undefined` or `null`, it returns an `EmptyState`. Otherwise, it returns a `ValidState` with the value and a setter to update the value.
+
+Parameters:
+
+- `state`: The `StateObject` which may contain a value, `undefined`, or `null`.
+
+Returns a `StateObject` of type `TOrigin` representing the value if it is defined and non-null, otherwise an `EmptyState`.
+
+
+
+
+
+
 ### Complete Example
 
 Here's a more complete example demonstrating the usage of `useStateObject`, `useFieldState`, `useElementState`,

package/dist/index.cjs

@@ -25,6 +25,7 @@ __export(index_exports, {
   useElementState: () => useElementState,
   useEmptyState: () => useEmptyState,
   useFieldState: () => useFieldState,
+  useNullSafety: () => useNullSafety,
   useRemapArray: () => useRemapArray,
   useStateObject: () => useStateObject
 });
@@ -156,6 +157,14 @@ function useArrayState(states) {
   return useStateObject(states.filter((state) => state.hasValue).map((state) => state.value));
 }
 
+// src/hooks/useNullSafety.ts
+function useNullSafety(state) {
+  if (!state.hasValue) return new EmptyState();
+  if (state.value === void 0) return new EmptyState();
+  if (state.value === null) return new EmptyState();
+  return new ValidState(state.value, (value) => state.value = value);
+}
+
 // src/index.ts
 var index_default = void 0;
 // Annotate the CommonJS export names for ESM import in node:
@@ -164,6 +173,7 @@ var index_default = void 0;
   useElementState,
   useEmptyState,
   useFieldState,
+  useNullSafety,
   useRemapArray,
   useStateObject
 });

package/dist/index.d.cts

@@ -127,6 +127,18 @@ declare function useArrayState<T>(states: StateObject<T>[]): StateObject<T[]>;
  */
 declare function useStateObject<T>(initialState: T): StateObject<T>;
 
+/**
+ * Hook that ensures a StateObject contains a defined, non-null value.
+ * If the StateObject's value is `undefined` or `null`, it returns an EmptyState.
+ * Otherwise, it returns a ValidState with the value and a setter to update the value.
+ *
+ * @template TOrigin - The type of the value contained in the StateObject.
+ * @param state - The StateObject which may contain a value, `undefined`, or `null`.
+ * @returns A new StateObject containing the value if it is defined and non-null,
+ *          otherwise an EmptyState.
+ */
+declare function useNullSafety<TOrigin>(state: StateObject<TOrigin | undefined | null>): StateObject<TOrigin>;
+
 declare const _default: undefined;
 
-export { type StateObject, _default as default, useArrayState, useElementState, useEmptyState, useFieldState, useRemapArray, useStateObject };
+export { type StateObject, _default as default, useArrayState, useElementState, useEmptyState, useFieldState, useNullSafety, useRemapArray, useStateObject };

package/dist/index.d.ts

@@ -127,6 +127,18 @@ declare function useArrayState<T>(states: StateObject<T>[]): StateObject<T[]>;
  */
 declare function useStateObject<T>(initialState: T): StateObject<T>;
 
+/**
+ * Hook that ensures a StateObject contains a defined, non-null value.
+ * If the StateObject's value is `undefined` or `null`, it returns an EmptyState.
+ * Otherwise, it returns a ValidState with the value and a setter to update the value.
+ *
+ * @template TOrigin - The type of the value contained in the StateObject.
+ * @param state - The StateObject which may contain a value, `undefined`, or `null`.
+ * @returns A new StateObject containing the value if it is defined and non-null,
+ *          otherwise an EmptyState.
+ */
+declare function useNullSafety<TOrigin>(state: StateObject<TOrigin | undefined | null>): StateObject<TOrigin>;
+
 declare const _default: undefined;
 
-export { type StateObject, _default as default, useArrayState, useElementState, useEmptyState, useFieldState, useRemapArray, useStateObject };
+export { type StateObject, _default as default, useArrayState, useElementState, useEmptyState, useFieldState, useNullSafety, useRemapArray, useStateObject };

package/dist/index.js

@@ -124,6 +124,14 @@ function useArrayState(states) {
   return useStateObject(states.filter((state) => state.hasValue).map((state) => state.value));
 }
 
+// src/hooks/useNullSafety.ts
+function useNullSafety(state) {
+  if (!state.hasValue) return new EmptyState();
+  if (state.value === void 0) return new EmptyState();
+  if (state.value === null) return new EmptyState();
+  return new ValidState(state.value, (value) => state.value = value);
+}
+
 // src/index.ts
 var index_default = void 0;
 export {
@@ -132,6 +140,7 @@ export {
   useElementState,
   useEmptyState,
   useFieldState,
+  useNullSafety,
   useRemapArray,
   useStateObject
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-state-monad",
   "type": "module",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "A set of hooks to manage/transform/filter states with monads in React",
   "keywords": [
     "maybe",

package/src/hooks/useNullSafety.ts

@@ -0,0 +1,24 @@
+import {StateObject} from "../stateObject";
+import {ValidState} from "../implementations/validState";
+import {EmptyState} from "../implementations/emptyState";
+
+/**
+ * Hook that ensures a StateObject contains a defined, non-null value.
+ * If the StateObject's value is `undefined` or `null`, it returns an EmptyState.
+ * Otherwise, it returns a ValidState with the value and a setter to update the value.
+ *
+ * @template TOrigin - The type of the value contained in the StateObject.
+ * @param state - The StateObject which may contain a value, `undefined`, or `null`.
+ * @returns A new StateObject containing the value if it is defined and non-null,
+ *          otherwise an EmptyState.
+ */
+export function useNullSafety<TOrigin>(state: StateObject<TOrigin | undefined | null>): StateObject<TOrigin> {
+
+    if (!state.hasValue) return new EmptyState<TOrigin>();
+
+    if (state.value === undefined) return new EmptyState<TOrigin>();
+
+    if (state.value === null) return new EmptyState<TOrigin>();
+
+    return new ValidState<TOrigin>(state.value, (value: TOrigin) => state.value = value);
+}

package/src/index.ts

@@ -4,6 +4,7 @@ export * from "./hooks/useEmptyState";
 export * from "./hooks/useFieldState";
 export * from "./hooks/useRemapArray";
 export * from "./hooks/useStateObject";
+export * from "./hooks/useNullSafety";
 export * from "./stateObject";
 
 export default this;