@douglasneuroinformatics/libjs 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './array.js';
 export * from './datetime.js';
+export * from './number.js';
 export * from './object.js';
 export * from './random.js';
 export * from './range.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from './array.js';
 export * from './datetime.js';
+export * from './number.js';
 export * from './object.js';
 export * from './random.js';
 export * from './range.js';

package/dist/number.d.ts

@@ -0,0 +1,7 @@
+/** Returns `true` if the value is a string representation of a number */
+export declare function isStringNumber(value: string): boolean;
+/** Returns `true` if the value is a number or string representation of a number */
+export declare function isNumberLike(value: unknown): value is number | string;
+/** Returns `value` as a number if it is a number or string representation of a number, otherwise returns `NaN` */
+export declare function parseNumber(value: unknown): number;
+//# sourceMappingURL=number.d.ts.map

package/dist/number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../src/number.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,WAK3C;AAED,mFAAmF;AACnF,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,GAAG,MAAM,CAOrE;AAED,kHAAkH;AAClH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAElD"}

package/dist/number.js

@@ -0,0 +1,21 @@
+/** Returns `true` if the value is a string representation of a number */
+export function isStringNumber(value) {
+    if (value.trim() !== '') {
+        return !Number.isNaN(+value);
+    }
+    return false;
+}
+/** Returns `true` if the value is a number or string representation of a number */
+export function isNumberLike(value) {
+    if (typeof value === 'number') {
+        return !Number.isNaN(value);
+    }
+    else if (typeof value === 'string') {
+        return isStringNumber(value);
+    }
+    return false;
+}
+/** Returns `value` as a number if it is a number or string representation of a number, otherwise returns `NaN` */
+export function parseNumber(value) {
+    return isNumberLike(value) ? Number(value) : NaN;
+}

package/dist/number.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=number.test.d.ts.map

package/dist/number.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.test.d.ts","sourceRoot":"","sources":["../src/number.test.ts"],"names":[],"mappings":""}

package/dist/number.test.js

@@ -0,0 +1,66 @@
+import { describe, expect, it } from 'vitest';
+import { isNumberLike, parseNumber } from './number.js';
+const NUMBER_LIKE_VALUES = [
+    5e3,
+    0xff,
+    -0.1,
+    -0,
+    0.0,
+    +0,
+    3.14,
+    '5e3',
+    '5e+3',
+    '-0.1',
+    '-0',
+    '0.0',
+    '+0',
+    '3.14',
+    Number.MAX_VALUE,
+    Number.MIN_VALUE,
+    Infinity,
+    -Infinity,
+    'Infinity',
+    '  +Infinity',
+    '  -Infinity  '
+];
+const NON_NUMBER_LIKE_VALUES = [
+    '--5',
+    'A5',
+    '5A',
+    NaN,
+    null,
+    undefined,
+    '',
+    '   ',
+    'foo',
+    [1],
+    {},
+    'NaN',
+    'infinity',
+    '--Infinity',
+    '++Infinity'
+];
+describe('isNumberLike', () => {
+    it('should return true for number-like values', () => {
+        NUMBER_LIKE_VALUES.forEach((value) => {
+            expect(isNumberLike(value)).toBe(true);
+        });
+    });
+    it('should return false for non-number-like values', () => {
+        NON_NUMBER_LIKE_VALUES.forEach((value) => {
+            expect(isNumberLike(value)).toBe(false);
+        });
+    });
+});
+describe('parseNumber', () => {
+    it('should parse numbers', () => {
+        NUMBER_LIKE_VALUES.forEach((value) => {
+            expect(Number.isNaN(parseNumber(value))).toBe(false);
+        });
+    });
+    it('should return NaN for non-numbers', () => {
+        NON_NUMBER_LIKE_VALUES.forEach((value) => {
+            expect(Number.isNaN(parseNumber(value))).toBe(true);
+        });
+    });
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@douglasneuroinformatics/libjs",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "packageManager": "pnpm@9.3.0",
   "description": "A collection of utility functions and types for Node.js and the browser",
   "author": "Joshua Unrau",