@alwatr/is-number 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.0.0 (2024-01-16)
+
+### Bug Fixes
+
+* **is-number:** Remove Number.isFinite polyfill ([aa149f3](https://github.com/Alwatr/nanolib/commit/aa149f302f96d961b058fc3a9d70399c1023cbe3)) by @AliMD
+
+### Features
+
+* **is-number:** extract from @alwatr/util ([1c8a676](https://github.com/Alwatr/nanolib/commit/1c8a676ccefcad12436f41b96eeb39c60cc09040)) by @njfamirm
+* **is-number:** Update is-number package description and add Number.isFinite polyfill ([a7c8e38](https://github.com/Alwatr/nanolib/commit/a7c8e38eb3e939199cf5637feaf08ac0ed98e2e6)) by @AliMD

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+# is-number
+
+A simple utility to Check the value is number or can convert to a number, for example string ' 123 ' can be converted to 123.
+
+## Installation
+
+```bash
+yarn add @alwatr/is-number
+```
+
+## Usage
+
+```typescript
+import {isNumber} from '@alwatr/is-number';
+
+isNumber('1'); // true
+```
+
+## Why is this needed?
+
+```ts
+console.log(typeof '123'); //=> 'string'
+console.log(+[]); //=> 0
+console.log(+''); //=> 0
+console.log(+'   '); //=> 0
+console.log(typeof NaN); //=> 'number'
+console.log(typeof Infinity); //=> 'number'
+```
+
+### True
+
+<!-- prettier-ignore -->
+```ts
+isNumber(5e3);               // true
+isNumber(0xff);              // true
+isNumber(-1.1);              // true
+isNumber(0);                 // true
+isNumber(1);                 // true
+isNumber(1.1);               // true
+isNumber('-1.1');            // true
+isNumber('0');               // true
+isNumber('0xff');            // true
+isNumber('1');               // true
+isNumber('1.1');             // true
+isNumber('5e3');             // true
+isNumber('012');             // true
+isNumber(parseInt('012'));   // true
+isNumber(parseFloat('012')); // true
+```
+
+### False
+
+<!-- prettier-ignore -->
+```ts
+isNumber(Infinity);          // false
+isNumber(NaN);               // false
+isNumber(null);              // false
+isNumber(undefined);         // false
+isNumber('');                // false
+isNumber('   ');             // false
+isNumber('foo');             // false
+isNumber([1]);               // false
+isNumber([]);                // false
+isNumber(function () {});    // false
+isNumber({});                // false
+```

package/dist/main.cjs

@@ -0,0 +1,3 @@
+/* @alwatr/is-number v1.0.0 */
+"use strict";var e=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var b=Object.prototype.hasOwnProperty;var m=(i,n)=>{for(var t in n)e(i,t,{get:n[t],enumerable:!0})},p=(i,n,t,o)=>{if(n&&typeof n=="object"||typeof n=="function")for(let r of s(n))!b.call(i,r)&&r!==t&&e(i,r,{get:()=>n[r],enumerable:!(o=f(n,r))||o.enumerable});return i};var u=i=>p(e({},"__esModule",{value:!0}),i);var N={};m(N,{isNumber:()=>F});module.exports=u(N);function F(i){return typeof i=="number"?i-i===0:typeof i=="string"&&i.trim()!==""?Number.isFinite?Number.isFinite(+i):isFinite(+i):!1}0&&(module.exports={isNumber});
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["/**\n * Check the value is number or can convert to a number, for example string ' 123 ' can be converted to 123\n *\n * @param value - the value must check numeric.\n *\n * @return true if the value is number or can convert to a number, otherwise false.\n *\n * @example\n * ```ts\n * isNumber(123); // true\n * isNumber('123'); // true\n * isNumber(' 123 '); // true\n * isNumber(''); // false\n * isNumber('  '); // false\n * isNumber(' 123a '); // false\n * isNumber(' 123 a '); // false\n * ```\n */\nexport function isNumber(value: unknown): boolean {\n  if (typeof value === 'number') {\n    return value - value === 0;\n  }\n  if (typeof value === 'string' && value.trim() !== '') {\n    return Number.isFinite ? Number.isFinite(+value) : isFinite(+value);\n  }\n  return false;\n}\n"],
+  "mappings": ";yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,cAAAE,IAAA,eAAAC,EAAAH,GAkBO,SAASE,EAASE,EAAyB,CAChD,OAAI,OAAOA,GAAU,SACZA,EAAQA,IAAU,EAEvB,OAAOA,GAAU,UAAYA,EAAM,KAAK,IAAM,GACzC,OAAO,SAAW,OAAO,SAAS,CAACA,CAAK,EAAI,SAAS,CAACA,CAAK,EAE7D,EACT",
+  "names": ["main_exports", "__export", "isNumber", "__toCommonJS", "value"]
+}

package/dist/main.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Check the value is number or can convert to a number, for example string ' 123 ' can be converted to 123
+ *
+ * @param value - the value must check numeric.
+ *
+ * @return true if the value is number or can convert to a number, otherwise false.
+ *
+ * @example
+ * ```ts
+ * isNumber(123); // true
+ * isNumber('123'); // true
+ * isNumber(' 123 '); // true
+ * isNumber(''); // false
+ * isNumber('  '); // false
+ * isNumber(' 123a '); // false
+ * isNumber(' 123 a '); // false
+ * ```
+ */
+export declare function isNumber(value: unknown): boolean;
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAQhD"}

package/dist/main.mjs

@@ -0,0 +1,3 @@
+/* @alwatr/is-number v1.0.0 */
+function n(i){return typeof i=="number"?i-i===0:typeof i=="string"&&i.trim()!==""?Number.isFinite?Number.isFinite(+i):isFinite(+i):!1}export{n as isNumber};
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["/**\n * Check the value is number or can convert to a number, for example string ' 123 ' can be converted to 123\n *\n * @param value - the value must check numeric.\n *\n * @return true if the value is number or can convert to a number, otherwise false.\n *\n * @example\n * ```ts\n * isNumber(123); // true\n * isNumber('123'); // true\n * isNumber(' 123 '); // true\n * isNumber(''); // false\n * isNumber('  '); // false\n * isNumber(' 123a '); // false\n * isNumber(' 123 a '); // false\n * ```\n */\nexport function isNumber(value: unknown): boolean {\n  if (typeof value === 'number') {\n    return value - value === 0;\n  }\n  if (typeof value === 'string' && value.trim() !== '') {\n    return Number.isFinite ? Number.isFinite(+value) : isFinite(+value);\n  }\n  return false;\n}\n"],
+  "mappings": ";AAkBO,SAASA,EAASC,EAAyB,CAChD,OAAI,OAAOA,GAAU,SACZA,EAAQA,IAAU,EAEvB,OAAOA,GAAU,UAAYA,EAAM,KAAK,IAAM,GACzC,OAAO,SAAW,OAAO,SAAS,CAACA,CAAK,EAAI,SAAS,CAACA,CAAK,EAE7D,EACT",
+  "names": ["isNumber", "value"]
+}

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@alwatr/is-number",
+  "version": "1.0.0",
+  "description": "A simple utility to Check the value is number or can convert to a number, for example string ' 123 ' can be converted to 123.",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
+  "keywords": [
+    "is-number",
+    "isnumber",
+    "isnan",
+    "finite",
+    "isfinite",
+    "is-nan",
+    "is-num",
+    "integer",
+    "is",
+    "kind",
+    "math",
+    "nan",
+    "num",
+    "number",
+    "numeric",
+    "parseFloat",
+    "parseInt",
+    "type",
+    "typeof",
+    "mathematics",
+    "cross-platform",
+    "ECMAScript",
+    "typescript",
+    "javascript",
+    "node",
+    "nodejs",
+    "browser",
+    "esm",
+    "module",
+    "utility",
+    "util",
+    "utils",
+    "nanolib",
+    "alwatr"
+  ],
+  "type": "module",
+  "main": "./dist/main.cjs",
+  "module": "./dist/main.mjs",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "types": "./dist/main.d.ts"
+    }
+  },
+  "license": "MIT",
+  "files": [
+    "**/*.{js,mjs,cjs,map,d.ts,html,md}",
+    "!demo/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alwatr/nanolib",
+    "directory": "packages/is-number"
+  },
+  "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/is-number#readme",
+  "bugs": {
+    "url": "https://github.com/Alwatr/nanolib/issues"
+  },
+  "prettier": "@alwatr/prettier-config",
+  "scripts": {
+    "b": "yarn run build",
+    "t": "yarn run test",
+    "w": "yarn run watch",
+    "c": "yarn run clean",
+    "cb": "yarn run clean && yarn run build",
+    "d": "yarn run build:es && yarn node --enable-source-maps --trace-warnings",
+    "build": "yarn run build:ts & yarn run build:es",
+    "build:es": "nano-build --preset=module",
+    "build:ts": "tsc --build",
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --enable-source-maps --experimental-vm-modules\" jest",
+    "watch": "yarn run watch:ts & yarn run watch:es",
+    "watch:es": "yarn run build:es --watch",
+    "watch:ts": "yarn run build:ts --watch --preserveWatchOutput",
+    "clean": "rm -rfv dist *.tsbuildinfo"
+  },
+  "devDependencies": {
+    "@alwatr/nano-build": "^1.3.1",
+    "@alwatr/prettier-config": "^1.0.4",
+    "@alwatr/tsconfig-base": "^1.1.1",
+    "@types/node": "^20.11.3",
+    "jest": "^29.7.0",
+    "typescript": "^5.3.3"
+  },
+  "gitHead": "369887cfdcbf5c6f3899880a5e217b102b36706c"
+}

package/src/main.test.js

@@ -0,0 +1,45 @@
+import { isNumber } from '@alwatr/is-number';
+
+describe('isNumber', () => {
+  it('should return true for numbers', () => {
+    expect(isNumber(123)).toBe(true);
+    expect(isNumber(0)).toBe(true);
+    expect(isNumber(-123)).toBe(true);
+    expect(isNumber(1.23)).toBe(true);
+  });
+
+  it('should return true for numeric strings', () => {
+    expect(isNumber('123')).toBe(true);
+    expect(isNumber('0')).toBe(true);
+    expect(isNumber('-123')).toBe(true);
+    expect(isNumber('1.23')).toBe(true);
+  });
+
+  it('should return false for non-numeric strings', () => {
+    expect(isNumber('abc')).toBe(false);
+    expect(isNumber('123abc')).toBe(false);
+    expect(isNumber('')).toBe(false);
+    expect(isNumber(' ')).toBe(false);
+  });
+
+  it('should return false for boolean values', () => {
+    expect(isNumber(true)).toBe(false);
+    expect(isNumber(false)).toBe(false);
+  });
+
+  it('should return false for null and undefined', () => {
+    expect(isNumber(null)).toBe(false);
+    expect(isNumber(undefined)).toBe(false);
+  });
+
+  it('should return false for objects and arrays', () => {
+    expect(isNumber({})).toBe(false);
+    expect(isNumber([])).toBe(false);
+  });
+
+  it('should return false for NaN and Infinity', () => {
+    expect(isNumber(NaN)).toBe(false);
+    expect(isNumber(Infinity)).toBe(false);
+    expect(isNumber(-Infinity)).toBe(false);
+  });
+});