Improve the performance

README.md

@@ -18,8 +18,8 @@ npm install strnum
 const toNumber = require("strnum");
 
 toNumber(undefined) // undefined
-toNumber(null)) //null
-toNumber("")) // ""
+toNumber(null) //null
+toNumber("") // ""
 toNumber("string"); //"string")
 toNumber("12,12"); //"12,12")
 toNumber("12 12"); //"12 12")

benchmark.js

@@ -0,0 +1,160 @@
+import { Bench } from 'tinybench'
+import toNumber from "./strnum.js"
+
+const bench = new Bench({ name: 'strnum benchmark', time: 100 })
+
+function toNumberBenchmark(str, options) {
+	bench.add(`${str}${options ? ', ' + JSON.stringify(options) : ''}`, () => {
+		toNumber(str, options)
+	})
+}
+
+toNumberBenchmark(undefined);
+toNumberBenchmark(null);
+toNumberBenchmark("");
+toNumberBenchmark("string");
+toNumberBenchmark("e89794659669cb7bb967db73a7ea6889c3891727")
+toNumberBenchmark("12,12");
+toNumberBenchmark("12 12");
+toNumberBenchmark("12-12");
+toNumberBenchmark("12.12.12");
+toNumberBenchmark("+12");
+toNumberBenchmark("+ 12");
+toNumberBenchmark("12+12");
+toNumberBenchmark("1212+");
+toNumberBenchmark("0x2f");
+toNumberBenchmark("-0x2f");
+toNumberBenchmark("0x2f", { hex: true });
+toNumberBenchmark("-0x2f", { hex: true });
+toNumberBenchmark("0x2f", { hex: false });
+toNumberBenchmark("-0x2f", { hex: false });
+toNumberBenchmark("0xzz");
+toNumberBenchmark("iweraf0x123qwerqwer");
+toNumberBenchmark("1230x55");
+toNumberBenchmark("JVBERi0xLjMNCiXi48");
+toNumberBenchmark("0");
+toNumberBenchmark("00");
+toNumberBenchmark("00.0");
+
+toNumberBenchmark("0", { leadingZeros: false });
+toNumberBenchmark("00", { leadingZeros: false });
+toNumberBenchmark("00.0", { leadingZeros: false });
+
+toNumberBenchmark("06");
+toNumberBenchmark("06", { leadingZeros: true });
+toNumberBenchmark("06", { leadingZeros: false });
+
+toNumberBenchmark("006");
+toNumberBenchmark("006", { leadingZeros: true });
+toNumberBenchmark("006", { leadingZeros: false });
+
+toNumberBenchmark("000000000000000000000000017717", { leadingZeros: false });
+toNumberBenchmark("000000000000000000000000017717", { leadingZeros: true });
+toNumberBenchmark("0420926189200190257681175017717");
+toNumberBenchmark("20.21.030");
+toNumberBenchmark("0.21.030");
+toNumberBenchmark("0.21.");
+toNumberBenchmark("0.");
+toNumberBenchmark("+0.");
+toNumberBenchmark("-0.");
+toNumberBenchmark("1.");
+toNumberBenchmark("00.00");
+toNumberBenchmark("0.06");
+toNumberBenchmark("00.6");
+toNumberBenchmark(".006");
+toNumberBenchmark("6.0");
+toNumberBenchmark("06.0");
+
+toNumberBenchmark("0.0", { leadingZeros: false });
+toNumberBenchmark("00.00", { leadingZeros: false });
+toNumberBenchmark("0.06", { leadingZeros: false });
+toNumberBenchmark("00.6", { leadingZeros: false });
+toNumberBenchmark(".006", { leadingZeros: false });
+toNumberBenchmark("6.0", { leadingZeros: false });
+toNumberBenchmark("06.0", { leadingZeros: false });
+toNumberBenchmark("+06");
+toNumberBenchmark("-06");
+toNumberBenchmark("-06", { leadingZeros: true });
+toNumberBenchmark("-06", { leadingZeros: false });
+
+toNumberBenchmark("-0.0");
+toNumberBenchmark("-00.00");
+toNumberBenchmark("-0.06");
+toNumberBenchmark("-00.6");
+toNumberBenchmark("-.006");
+toNumberBenchmark("-6.0");
+toNumberBenchmark("-06.0");
+toNumberBenchmark("+06.0");
+
+toNumberBenchmark("-0.0", { leadingZeros: false });
+toNumberBenchmark("-00.00", { leadingZeros: false });
+toNumberBenchmark("-0.06", { leadingZeros: false });
+toNumberBenchmark("-00.6", { leadingZeros: false });
+toNumberBenchmark("-.006", { leadingZeros: false });
+toNumberBenchmark("-6.0", { leadingZeros: false });
+toNumberBenchmark("-06.0", { leadingZeros: false });
+toNumberBenchmark("020211201030005811824");
+toNumberBenchmark("20211201030005811824");
+toNumberBenchmark("20.211201030005811824");
+toNumberBenchmark("0.211201030005811824");
+toNumberBenchmark("01.0e2", { leadingZeros: false });
+toNumberBenchmark("-01.0e2", { leadingZeros: false });
+toNumberBenchmark("01.0e2");
+toNumberBenchmark("-01.0e2");
+toNumberBenchmark("1.0e2");
+
+toNumberBenchmark("-1.0e2");
+toNumberBenchmark("1.0e-2");
+
+toNumberBenchmark("420926189200190257681175017717");
+toNumberBenchmark("420926189200190257681175017717", { eNotation: false });
+
+toNumberBenchmark("1e-2");
+toNumberBenchmark("1e+2");
+toNumberBenchmark("1.e+2");
+toNumberBenchmark("01.0E2", { leadingZeros: false });
+toNumberBenchmark("-01.0E2", { leadingZeros: false });
+toNumberBenchmark("01.0E2");
+toNumberBenchmark("-01.0E2");
+toNumberBenchmark("1.0E2");
+
+toNumberBenchmark("-1.0E2");
+toNumberBenchmark("1.0E-2");
+
+toNumberBenchmark("E-2");
+toNumberBenchmark("E2");
+toNumberBenchmark("0E2");
+toNumberBenchmark("-0E2");
+toNumberBenchmark("00E2");
+toNumberBenchmark("00E2", { leadingZeros: false });
+toNumberBenchmark("0", { skipLike: /.*/ });
+toNumberBenchmark("+12", { skipLike: /\+[0-9]{10}/ });
+toNumberBenchmark("12+12", { skipLike: /\+[0-9]{10}/ });
+toNumberBenchmark("12+1212121212", { skipLike: /\+[0-9]{10}/ });
+toNumberBenchmark("+1212121212");
+toNumberBenchmark("+1212121212", { skipLike: /\+[0-9]{10}/ });
+toNumberBenchmark("+12 12");
+toNumberBenchmark("    +12 12   ");
+toNumberBenchmark("   +1212   ");
+toNumberBenchmark("+1212");
+toNumberBenchmark("+12.12");
+toNumberBenchmark("-12.12");
+toNumberBenchmark("-012.12");
+
+toNumberBenchmark("Infinity");
+toNumberBenchmark("-Infinity");
+toNumberBenchmark("+Infinity");
+toNumberBenchmark("Infinity", { infinity: true });
+toNumberBenchmark("-Infinity", { infinity: true });
+toNumberBenchmark("+Infinity", { infinity: true });
+toNumberBenchmark("Infinity", { infinity: false });
+toNumberBenchmark("-Infinity", { infinity: false });
+toNumberBenchmark("+Infinity", { infinity: false });
+toNumberBenchmark("  Infinity  ");
+toNumberBenchmark("  -Infinity  ");
+toNumberBenchmark("  +Infinity  ");
+
+await bench.run()
+
+console.log(bench.name)
+console.table(bench.table())

package.json

@@ -4,8 +4,10 @@
   "description": "Parse String to Number based on configuration",
   "type": "module",
   "main": "strnum.js",
+  "types": "strnum.d.ts",
   "scripts": {
-    "test": "jasmine strnum.test.js"
+    "test": "jasmine *.test.js",
+    "types": "tsc -p ."
   },
   "keywords": [
     "string",
@@ -26,6 +28,8 @@
     }
   ],
   "devDependencies": {
-    "jasmine": "^5.6.0"
+    "jasmine": "^5.6.0",
+    "tinybench": "^4.0.1",
+    "typescript": "^5.8.3"
   }
-}
+}

strnum.d.ts

@@ -0,0 +1,92 @@
+declare module "strnum" {
+    /**
+     * @template {*} T
+     * @param {T} str - The string to convert to a number.
+     * @param {Options} [options] - Options to control the conversion behavior.
+     * @returns {number|T} - The converted number or the original value if conversion is not applicable.
+     */
+    export default function toNumber<T extends unknown>(str: T, options?: Options): number | T;
+    /**
+     * @param {string} str - The string to analyze.
+     * @param {Options} options - Options to control the parsing behavior.
+     * @returns {number} - A bitmask representing the analysis result of the string.
+     */
+    export function analyzeNumber(str: string, options: Options): number;
+    export type State = typeof NUMBER | typeof NOT_A_NUMBER | typeof BINARY | typeof DECIMAL | typeof OCTAL | typeof HEX | typeof FLOAT | typeof INTEGER | typeof BIGINT | typeof ZERO | typeof WHITESPACE | typeof BEGIN | typeof END | typeof LEADING_WHITESPACE | typeof TRAILING_WHITESPACE | typeof BEGIN_INTEGER_DIGITS | typeof BEGIN_FRAC_DIGITS | typeof BEGIN_BINARY | typeof BEGIN_HEX | typeof BEGIN_OCTAL | typeof BEGIN_EXPONENT | typeof BEGIN_ZERO | typeof FIRST_DIGIT_ZERO_NOT_LEADING | typeof LEADING_ZEROS | typeof INFINITY | typeof SIGN | typeof EXPONENT_INDICATOR | typeof EXPONENT_SIGN | typeof EXPONENT_DECIMAL;
+    export type Options = {
+        /**
+         * - Whether to allow hexadecimal numbers (e.g., "0x1A").
+         */
+        hex?: boolean;
+        /**
+         * - Whether to allow octal numbers (e.g., "0o17").
+         */
+        octal?: boolean;
+        /**
+         * - Whether to allow binary numbers (e.g., "0b1010").
+         */
+        binary?: boolean;
+        /**
+         * - Whether to allow BigInt numbers (e.g., "123n").
+         */
+        bigint?: boolean;
+        /**
+         * - Whether to allow leading zeros in numbers (e.g., "000123").
+         */
+        leadingZeros?: boolean;
+        /**
+         * - Whether to check if the number is a safe integer.
+         */
+        safeInteger?: boolean;
+        /**
+         * - Whether to allow "Infinity" and "-Infinity".
+         */
+        infinity?: boolean;
+        /**
+         * - A regular expression to skip certain string patterns.
+         */
+        skipLike?: RegExp;
+        /**
+         * - Whether to allow scientific notation (e.g., "1e10").
+         */
+        eNotation?: boolean;
+        /**
+         * - Whether to treat empty strings or strings with whitespace as zero (e.g., " ").
+         */
+        empty?: boolean;
+        /**
+         * - Whether to force IEEE 754 compliance for floating-point numbers (e.g. "1234567890.1234567890" => 1234567890.1234567).
+         */
+        ieee754?: boolean;
+    };
+    const NUMBER: 0;
+    const NOT_A_NUMBER: 1;
+    const BINARY: 2;
+    const DECIMAL: 4;
+    const OCTAL: 8;
+    const HEX: 16;
+    const FLOAT: 32;
+    const INTEGER: 64;
+    const BIGINT: 128;
+    const ZERO: 2048;
+    const WHITESPACE: 512;
+    const BEGIN: 8192;
+    const END: 16384;
+    const LEADING_WHITESPACE: 8704;
+    const TRAILING_WHITESPACE: 16896;
+    const BEGIN_INTEGER_DIGITS: 8196;
+    const BEGIN_FRAC_DIGITS: 8224;
+    const BEGIN_BINARY: 8194;
+    const BEGIN_HEX: 8208;
+    const BEGIN_OCTAL: 8200;
+    const BEGIN_EXPONENT: 12288;
+    const BEGIN_ZERO: 10240;
+    const FIRST_DIGIT_ZERO_NOT_LEADING: 26624;
+    const LEADING_ZEROS: 10244;
+    const INFINITY: 256;
+    const SIGN: 1024;
+    const EXPONENT_INDICATOR: 4096;
+    const EXPONENT_SIGN: 5120;
+    const EXPONENT_DECIMAL: 4100;
+    export {};
+}