feat: toStringNumber

Author: fardad-dev

__tests__/convert.test.js

@@ -63,3 +63,45 @@ test("parseNumber with max", () => {
     "100",
   );
 });
+
+test("Negative number", () => {
+  expect(starkString("-48g39 d").toNumber({ negative: false })).toBe(4839);
+
+  expect(starkString("d -48g39 d").toStringNumber()).toBe("-4839");
+
+  expect(starkString("-48g39 d").toNumber()).toBe(-4839);
+  expect(starkString("-48g-39 d").toNumber()).toBe(-4839);
+
+  expect(starkString("-").toStringNumber()).toBe("-");
+
+  expect(starkString("48g39 d").toStringNumber()).toBe("4839");
+});
+
+test("Decimal number", () => {
+  expect(
+    starkString("-48g.39 d").toStringNumber({
+      negative: false,
+      decimal: false,
+    }),
+  ).toBe("4839");
+
+  expect(starkString("d 48g34.9 d").toStringNumber({ decimal: true })).toBe(
+    "4834.9",
+  );
+
+  expect(starkString(".48g39 d").toStringNumber({ decimal: true })).toBe(
+    "0.4839",
+  );
+
+  expect(starkString("4.8g39 d").toStringNumber()).toBe("4.839");
+});
+
+test("Decimal Negative number", () => {
+  expect(starkString("-48g.39 d").toStringNumber()).toBe("-48.39");
+
+  expect(starkString("d 4-8g34.9 d").toStringNumber()).toBe("4834.9");
+
+  expect(starkString("-.48g39 d").toStringNumber()).toBe("-0.4839");
+
+  expect(starkString(" -4.8g39 d").toStringNumber()).toBe("-4.839");
+});

package.json

@@ -38,14 +38,14 @@
         "eslint": "7.3.1",
         "eslint-plugin-prettier": "3.1.4",
         "jest": "26.0.1",
-        "prettier": "2.0.5",
-        "prettier-plugin-jsdoc": "^0.2.0",
+        "prettier": "^2.3.2",
+        "prettier-plugin-jsdoc": "^0.3.23",
         "ts-jest": "25.5.1",
-        "typescript": "^4.0.3"
+        "typescript": "^4.3.5"
     },
     "scripts": {
         "prepare": "yarn build",
         "build": "tsc",
         "test": "yarn build && jest"
     }
-}
+}

src/index.ts

@@ -12,6 +12,7 @@
   currency,
   security,
   parseNumber,
+  toNumber,
 } from "./lib";
 import NativeString from "./NativeString";
 
@@ -73,8 +74,7 @@ class StarkString extends NativeString {
 
   /**
    * Used for decode Persian Characters in URL
-   * https://fa.wikipedia.org/wiki/مدیاویکی:Gadget-Extra-Editbuttons-Functions.
-   * s
+   * https://fa.wikipedia.org/wiki/مدیاویکی:Gadget-Extra-Editbuttons-Functions.js
    */
   fixURL(): StarkString {
     this._value = decodeURL(this._value);
@@ -83,8 +83,7 @@ class StarkString extends NativeString {
 
   /**
    * Used for decode Persian Characters in URL
-   * https://fa.wikipedia.org/wiki/مدیاویکی:Gadget-Extra-Editbuttons-Functions.
-   * s
+   * https://fa.wikipedia.org/wiki/مدیاویکی:Gadget-Extra-Editbuttons-Functions.js
    */
   decodeURL(): StarkString {
     this._value = decodeURL(this._value);
@@ -142,8 +141,15 @@ class StarkString extends NativeString {
     return this;
   }
 
-  /** Convert to number by native Number function */
-  toNumber(): number {
+  /** Convert any string to number */
+  toStringNumber(options?: Parameters<typeof toNumber>[1]): string {
+    this._value = toNumber(this._value, options);
+    return this._value;
+  }
+
+  /** Convert any string to number */
+  toNumber(options?: Parameters<typeof toNumber>[1]): number {
+    this.toStringNumber(options);
     return Number(this._value);
   }
 }

src/lib.ts

@@ -315,14 +315,74 @@ function halfSpace(value: string): string {
   return value;
 }
 
-/** Remove anything expect numbers */
+/** Remove anything expect numbers, this function will remove negative and decimal */
 function parseNumber(value: string): string {
   return englishNumber(value).replace(/\D/g, "");
 }
 
+/**
+ * Convert numbers to english number and remove anything expect integer or decimal
+ * numbers
+ */
+function toNumber(
+  value: string,
+  {
+    negative = true,
+    decimal = true,
+    max,
+    min,
+  }: {
+    /** Default is true */
+    negative?: boolean;
+    /** Default is true */
+    decimal?: boolean;
+    max?: number;
+    min?: number;
+  } = {},
+): string {
+  let num =
+    englishNumber(value)
+      .match(/(-?\.?\d?)+/g)
+      ?.join("") || "";
+
+  // if (options?.negative && options?.decimal) {
+
+  // }
+  if (decimal && negative) {
+    num = num.replace(/(^.+)(-)/g, "$1");
+    num = num.replace(/^\./g, "0.");
+    num = num.replace(/^-\./g, "-0.");
+    num = num.match(/^-?\d*\.?\d*$/g)?.join("") || "";
+  } else {
+    if (negative) {
+      num = num.replace(/(^.+)(-)/g, "$1");
+      num = num.match(/^-?(\d?)+$/g)?.join("") || "";
+    } else if (decimal) {
+      num = num.replace(/^\./g, "0.");
+      num = num.match(/\d*\.?\d*$/g)?.join("") || "";
+    } else {
+      num = num.replace(/\D/g, "");
+    }
+  }
+
+  if (typeof max === "number") {
+    if (Number(num) > max) {
+      num = String(max);
+    }
+  }
+
+  if (typeof min === "number") {
+    if (Number(num) < min) {
+      num = String(min);
+    }
+  }
+
+  return num;
+}
+
 /** Used for validation integer number */
 function isInteger(value: string): boolean {
-  return /^\d+$/.test(value);
+  return Number.isInteger(Number(value));
 }
 
 /**
@@ -392,4 +452,5 @@ export {
   currency,
   security,
   parseNumber,
+  toNumber,
 };