fix: formatNumber now accepts floating-point numbers

Author: syntaxlexx

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acelords/js-utils",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Common utils and helpers used on node projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/index.ts

@@ -91,13 +91,16 @@ export const randomString = (length = 6, includeNumbers = false) => {
  * - isNumeric('1234')         // true
  * - isNumeric('1234n')         // true
  * - isNumeric('123.4')         // false
+ * - isNumeric('123.4', true)         // true
  * - isNumeric('')         // false
  * - isNumeric(undefined)         // false
  * - isNumeric(null)         // false
  */
-export function isNumeric(value: string | number | undefined | null): boolean {
+export function isNumeric(value: string | number | undefined | null, allowFloat = false): boolean {
     if (!value) return false;
-    return /^-?\d+$/.test(value.toString());
+    return allowFloat
+        ? /^-?\d+\.?\d*$/.test(value.toString())
+        : /^-?\d+$/.test(value.toString());
 }
 
 /**
@@ -136,7 +139,7 @@ export const substring = (str: string | null | undefined, end: number): string =
 export const numberFormat = (value: string | number | undefined | null, toInt = false): string => {
     const format = toInt ? '0,0' : "0,0.00"
     if (value === 0 || value === "0") return numeral(value).format(format)
-    if (!value || !isNumeric(value)) return ""
+    if (!value || !isNumeric(value, true)) return ""
     return numeral(value).format(format)
 }
 
@@ -167,7 +170,7 @@ export const formatNumber = (value: string | number | undefined | null, toInt =
 export const formatCurrency = (value: string | number | undefined | null): string => {
     const format = "0,0.00"
     if (value === 0 || value === "0") return numeral(0).format(format)
-    if (!value || !isNumeric(value)) return ""
+    if (!value || !isNumeric(value, true)) return ""
     const amount = Number(value.toString()) / 100;
     return numeral(amount).format(format)
 }

src/utils.test.ts

@@ -119,8 +119,9 @@ test("isNumeric - check if a string|number is numeric", () => {
     expect(isNumeric('1234567890')).toBeTruthy();
     expect(isNumeric('-23')).toBeTruthy();
     expect(isNumeric('1234')).toBeTruthy();
-    // expect(isNumeric('1234e')).toBeTruthy();
     expect(isNumeric('123.4')).toBeFalsy();
+    expect(isNumeric('123.4', true)).toBeTruthy();
+    expect(isNumeric('1234e')).toBeFalsy();
     expect(isNumeric('')).toBeFalsy();
     expect(isNumeric(undefined)).toBeFalsy();
     expect(isNumeric(null)).toBeFalsy();
@@ -160,6 +161,10 @@ test("numberFormat - can format numeric strings and numbers", () => {
     expect(numberFormat(0, true)).toBe("0");
     expect(numberFormat('123456')).toBe("123,456.00");
     expect(numberFormat('123456', true)).toBe("123,456");
+    expect(numberFormat('1.3333333333')).toBe("1.33");
+    expect(numberFormat('-1.3333333333')).toBe("-1.33");
+    expect(numberFormat('1.3333333333', true)).toBe("1");
+    expect(numberFormat('-1.3333333333', true)).toBe("-1");
 });
 
 test("formatNumber - can format numeric strings and numbers", () => {
@@ -172,6 +177,10 @@ test("formatNumber - can format numeric strings and numbers", () => {
     expect(formatNumber(0, true)).toBe("0");
     expect(formatNumber('123456')).toBe("123,456.00");
     expect(formatNumber('123456', true)).toBe("123,456");
+    expect(formatNumber('1.3333333333')).toBe("1.33");
+    expect(formatNumber('-1.3333333333')).toBe("-1.33");
+    expect(formatNumber('1.3333333333', true)).toBe("1");
+    expect(formatNumber('-1.3333333333', true)).toBe("-1");
 });
 
 /*======== formatCurrency =============*/
@@ -183,6 +192,9 @@ test("formatCurrency - can format numeric strings and numbers to currency", () =
     expect(formatCurrency(0)).toBe("0.00");
     expect(formatCurrency('123456')).toBe("1,234.56");
     expect(formatCurrency('12345600')).toBe("123,456.00");
+    expect(formatCurrency('-12345600')).toBe("-123,456.00");
+    expect(formatCurrency('-100.333333333')).toBe("-1.00");
+    expect(formatCurrency('-10.333333333')).toBe("-0.10");
 });
 
 /*======== slugify =============*/
@@ -434,8 +446,12 @@ test("countWordsFromHtml - can get number of words in a string", () => {
 
 /*======== birthdayFromNow =============*/
 test("birthdayFromNow - can get days to next birthday", () => {
-    expect(birthdayFromNow(dayjs('2023-08-23').subtract(4, 'days').toDate())).toBe(361);
-    expect(birthdayFromNow(dayjs('2023-08-23').add(4, 'days').toDate())).toBe(3);
+    expect(birthdayFromNow(dayjs().subtract(4, 'days').toDate())).toBeGreaterThanOrEqual(361);
+    expect(birthdayFromNow(dayjs().subtract(4, 'days').toDate())).toBeLessThanOrEqual(362);
+
+    expect(birthdayFromNow(dayjs().add(4, 'days').toDate())).toBeGreaterThanOrEqual(3);
+    expect(birthdayFromNow(dayjs().add(4, 'days').toDate())).toBeLessThanOrEqual(4);
+
     expect(birthdayFromNow(dayjs().toDate())).toBe(0);
     expect(birthdayFromNow(null)).toBe(null);
     expect(birthdayFromNow(undefined)).toBe(null);