feat: add toNumberOrNull utility function for safe number conversion

Author: MickaelAustoni

CHANGELOG.md

@@ -1,4 +1,4 @@
 # [Versions](https://github.com/Tracktor/react-utils/releases)
 
-## v1.27.1
-- **[fix]** : Enhance play function in useAudio hook to reset currentTime before playback
+## v1.28.0
+- **[FEAT]** :  add toNumberOrNull utility function for safe number conversion

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tracktor/react-utils",
   "description": "React data table and react data grid",
-  "version": "1.27.1",
+  "version": "1.28.0",
   "private": false,
   "license": "ISC",
   "type": "module",

src/main.ts

@@ -1,5 +1,3 @@
-// Hook
-
 export * from "@/hooks/useAudio/useAudio";
 export { default as useAudio } from "@/hooks/useAudio/useAudio";
 export * from "@/hooks/useDebounce/useDebounce";
@@ -52,14 +50,15 @@ export * from "@/utils/is/isRef";
 export { default as isRef } from "@/utils/is/isRef";
 export * from "@/utils/is/isString";
 export { default as isString } from "@/utils/is/isString";
+export * from "@/utils/number/toNumber/toNumberOrNull";
+export { default as toNumberOrNull } from "@/utils/number/toNumber/toNumberOrNull";
 export * from "@/utils/number/toNumber/toNumberOrZero";
 export { default as toNumberOrZero } from "@/utils/number/toNumber/toNumberOrZero";
 export * from "@/utils/object/getObjectValue/getObjectValue";
 export { default as getObjectValue } from "@/utils/object/getObjectValue/getObjectValue";
 export * from "@/utils/object/isDeepEqualObject";
 export { default as isDeepEqualObject } from "@/utils/object/isDeepEqualObject";
 export * from "@/utils/object/removeObjectProperty";
-// Utils
 export { default as removeObjectProperty } from "@/utils/object/removeObjectProperty";
 export * from "@/utils/string/capitalize";
 export { default as capitalize } from "@/utils/string/capitalize";

src/utils/number/toNumber/toNumberOrNull.test.ts

@@ -0,0 +1,26 @@
+import { describe, expect, it } from "vitest";
+import toNumberOrNull from "./toNumberOrNull";
+
+describe("toNumberOrNull", () => {
+  it("devrait retourner un nombre pour les valeurs numériques", () => {
+    expect(toNumberOrNull(42)).toBe(42);
+    expect(toNumberOrNull("42")).toBe(42);
+    expect(toNumberOrNull(0)).toBe(0);
+    expect(toNumberOrNull("0")).toBe(0);
+    expect(toNumberOrNull(-42)).toBe(-42);
+    expect(toNumberOrNull("-42")).toBe(-42);
+    expect(toNumberOrNull(3.14)).toBe(3.14);
+    expect(toNumberOrNull("3.14")).toBe(3.14);
+  });
+
+  it("devrait retourner null pour les valeurs non numériques", () => {
+    expect(toNumberOrNull("abc")).toBeNull();
+    expect(toNumberOrNull(null)).toBeNull();
+    expect(toNumberOrNull(undefined)).toBeNull();
+    expect(toNumberOrNull({})).toBeNull();
+    expect(toNumberOrNull([])).toBeNull();
+    expect(toNumberOrNull(NaN)).toBeNull();
+    expect(toNumberOrNull(true)).toBeNull();
+    expect(toNumberOrNull(false)).toBeNull();
+  });
+});

src/utils/number/toNumber/toNumberOrNull.ts

@@ -0,0 +1,15 @@
+/**
+ * Convert a value to a number or return null
+ * This function avoid NaN values
+ * @param value
+ */
+const toNumberOrNull = (value: unknown): number | null => {
+  if (value === null || value === undefined || typeof value === "boolean" || typeof value === "object") {
+    return null;
+  }
+
+  const num = Number(value);
+  return Number.isNaN(num) ? null : num;
+};
+
+export default toNumberOrNull;