@js-utils-kit/number 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sriman
+
+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/dist/index.cjs

@@ -0,0 +1 @@
+function e(e,t,n){return Math.min(Math.max(e,t),n)}function t(e=0,t=0,n=0,r=0){if([e,t,n,r].some(e=>e<0))throw Error(`All time values must be non-negative numbers.`);return(e*24*60*60+t*60*60+n*60+r)*1e3}function n(e){return e%2==0}function r(e){return e%2!=0}function i(e,t){return Math.random()*(t-e)+e}function a(e,t){return Math.floor(Math.random()*(t-e+1))+e}exports.clamp=e,exports.getMilliseconds=t,exports.isEven=n,exports.isOdd=r,exports.randomFloat=i,exports.randomInt=a;var o=require(`@js-utils-kit/types`);Object.keys(o).forEach(function(e){e!==`default`&&!Object.prototype.hasOwnProperty.call(exports,e)&&Object.defineProperty(exports,e,{enumerable:!0,get:function(){return o[e]}})});

package/dist/index.d.cts

@@ -0,0 +1,108 @@
+import { Hour, MinuteOrSecond } from "@js-utils-kit/types";
+export * from "@js-utils-kit/types";
+
+//#region src/clamp.d.ts
+
+/**
+ * Clamps a number between a minimum and maximum value.
+ *
+ * Ensures that the returned number is not less than `min` and not more than `max`.
+ *
+ * @returns The clamped number.
+ *
+ * @example
+ * ```ts
+ * clamp(5, 1, 10); // 5
+ * clamp(0, 1, 10); // 1
+ * clamp(15, 1, 10); // 10
+ * ```
+ */
+declare function clamp(/** The number to clamp */
+value: number, /** The minimum allowed value */
+min: number, /** The maximum allowed value */
+max: number): number;
+//#endregion
+//#region src/getMilliseconds.d.ts
+/**
+ * Converts a time duration (days, hours, minutes, seconds) into total milliseconds.
+ *
+ * @returns The equivalent duration in milliseconds.
+ *
+ * @throws Will throw an error if any parameter is negative.
+ *
+ * @example
+ * ```ts
+ * getMilliseconds(1);             // 86400000 (1 day)
+ * getMilliseconds(0, 1);          // 3600000  (1 hour)
+ * getMilliseconds(0, 0, 30, 15);  // 1815000  (30 minutes 15 seconds)
+ * ```
+ */
+declare function getMilliseconds(/** Number of days. */
+days?: number, /** Hour of the day (`0–23`). */
+hours?: Hour, /** Minute value (`0–59`). */
+minutes?: MinuteOrSecond, /** Second value (`0–59`). */
+seconds?: MinuteOrSecond): number;
+//#endregion
+//#region src/isEven.d.ts
+/**
+ * Checks if a number is even.
+ *
+ * @returns True if the number is even, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isEven(4); // true
+ * isEven(3); // false
+ * ```
+ */
+declare function isEven(/** The number to check */
+value: number): boolean;
+//#endregion
+//#region src/isOdd.d.ts
+/**
+ * Checks if a number is odd.
+ *
+ * @returns True if the number is odd, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isOdd(3); // true
+ * isOdd(4); // false
+ * ```
+ */
+declare function isOdd(/** The number to check */
+value: number): boolean;
+//#endregion
+//#region src/randomFloat.d.ts
+/**
+ * Returns a random floating-point number between `min` and `max`.
+ *
+ * @returns A random float between min and max.
+ *
+ * @example
+ * ```ts
+ * randomFloat(0, 1); // 0.624...
+ * randomFloat(1.5, 5.2); // 3.1415...
+ * ```
+ */
+declare function randomFloat(/** Minimum value */
+min: number, /** Maximum value */
+max: number): number;
+//#endregion
+//#region src/randomInt.d.ts
+/**
+ * Returns a random integer between `min` and `max`, inclusive.
+ *
+ * @returns A random integer between min and max.
+ *
+ * @example
+ * ```ts
+ * randomInt(1, 5); // 3
+ * randomInt(10, 20); // 17
+ * ```
+ */
+declare function randomInt(/** Minimum value */
+min: number, /** Maximum value */
+max: number): number;
+//#endregion
+export { clamp, getMilliseconds, isEven, isOdd, randomFloat, randomInt };

package/dist/index.d.mts

@@ -0,0 +1,108 @@
+import { Hour, MinuteOrSecond } from "@js-utils-kit/types";
+export * from "@js-utils-kit/types";
+
+//#region src/clamp.d.ts
+
+/**
+ * Clamps a number between a minimum and maximum value.
+ *
+ * Ensures that the returned number is not less than `min` and not more than `max`.
+ *
+ * @returns The clamped number.
+ *
+ * @example
+ * ```ts
+ * clamp(5, 1, 10); // 5
+ * clamp(0, 1, 10); // 1
+ * clamp(15, 1, 10); // 10
+ * ```
+ */
+declare function clamp(/** The number to clamp */
+value: number, /** The minimum allowed value */
+min: number, /** The maximum allowed value */
+max: number): number;
+//#endregion
+//#region src/getMilliseconds.d.ts
+/**
+ * Converts a time duration (days, hours, minutes, seconds) into total milliseconds.
+ *
+ * @returns The equivalent duration in milliseconds.
+ *
+ * @throws Will throw an error if any parameter is negative.
+ *
+ * @example
+ * ```ts
+ * getMilliseconds(1);             // 86400000 (1 day)
+ * getMilliseconds(0, 1);          // 3600000  (1 hour)
+ * getMilliseconds(0, 0, 30, 15);  // 1815000  (30 minutes 15 seconds)
+ * ```
+ */
+declare function getMilliseconds(/** Number of days. */
+days?: number, /** Hour of the day (`0–23`). */
+hours?: Hour, /** Minute value (`0–59`). */
+minutes?: MinuteOrSecond, /** Second value (`0–59`). */
+seconds?: MinuteOrSecond): number;
+//#endregion
+//#region src/isEven.d.ts
+/**
+ * Checks if a number is even.
+ *
+ * @returns True if the number is even, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isEven(4); // true
+ * isEven(3); // false
+ * ```
+ */
+declare function isEven(/** The number to check */
+value: number): boolean;
+//#endregion
+//#region src/isOdd.d.ts
+/**
+ * Checks if a number is odd.
+ *
+ * @returns True if the number is odd, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isOdd(3); // true
+ * isOdd(4); // false
+ * ```
+ */
+declare function isOdd(/** The number to check */
+value: number): boolean;
+//#endregion
+//#region src/randomFloat.d.ts
+/**
+ * Returns a random floating-point number between `min` and `max`.
+ *
+ * @returns A random float between min and max.
+ *
+ * @example
+ * ```ts
+ * randomFloat(0, 1); // 0.624...
+ * randomFloat(1.5, 5.2); // 3.1415...
+ * ```
+ */
+declare function randomFloat(/** Minimum value */
+min: number, /** Maximum value */
+max: number): number;
+//#endregion
+//#region src/randomInt.d.ts
+/**
+ * Returns a random integer between `min` and `max`, inclusive.
+ *
+ * @returns A random integer between min and max.
+ *
+ * @example
+ * ```ts
+ * randomInt(1, 5); // 3
+ * randomInt(10, 20); // 17
+ * ```
+ */
+declare function randomInt(/** Minimum value */
+min: number, /** Maximum value */
+max: number): number;
+//#endregion
+export { clamp, getMilliseconds, isEven, isOdd, randomFloat, randomInt };

package/dist/index.mjs

@@ -0,0 +1 @@
+export*from"@js-utils-kit/types";function e(e,t,n){return Math.min(Math.max(e,t),n)}function t(e=0,t=0,n=0,r=0){if([e,t,n,r].some(e=>e<0))throw Error(`All time values must be non-negative numbers.`);return(e*24*60*60+t*60*60+n*60+r)*1e3}function n(e){return e%2==0}function r(e){return e%2!=0}function i(e,t){return Math.random()*(t-e)+e}function a(e,t){return Math.floor(Math.random()*(t-e+1))+e}export{e as clamp,t as getMilliseconds,n as isEven,r as isOdd,i as randomFloat,a as randomInt};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@js-utils-kit/number",
+  "version": "1.0.0",
+  "description": "Number utilities",
+  "private": false,
+  "license": "MIT",
+  "author": {
+    "name": "Sriman",
+    "email": "136729116+TenEplaysOfficial@users.noreply.github.com",
+    "url": "https://tene.vercel.app"
+  },
+  "homepage": "https://js-utils.js.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teneplaysofficial/js-utils-kit",
+    "directory": "packages/number"
+  },
+  "bugs": {
+    "url": "https://github.com/teneplaysofficial/js-utils-kit/issues"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@js-utils-kit/types": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run"
+  }
+}