es-toolkit 1.19.0-dev.621 → 1.19.0-dev.622

package/dist/compat/index.d.mts

@@ -57,7 +57,6 @@ export { MemoizeCache, memoize } from '../function/memoize.mjs';
 export { unary } from '../function/unary.mjs';
 export { partial } from '../function/partial.mjs';
 export { partialRight } from '../function/partialRight.mjs';
-export { clamp } from '../math/clamp.mjs';
 export { inRange } from '../math/inRange.mjs';
 export { mean } from '../math/mean.mjs';
 export { meanBy } from '../math/meanBy.mjs';
@@ -171,6 +170,7 @@ export { repeat } from './string/repeat.mjs';
 export { trim } from './string/trim.mjs';
 export { trimStart } from './string/trimStart.mjs';
 export { trimEnd } from './string/trimEnd.mjs';
+export { clamp } from './math/clamp.mjs';
 export { max } from './math/max.mjs';
 export { min } from './math/min.mjs';
 export { ceil } from './math/ceil.mjs';

package/dist/compat/index.d.ts

@@ -57,7 +57,6 @@ export { MemoizeCache, memoize } from '../function/memoize.js';
 export { unary } from '../function/unary.js';
 export { partial } from '../function/partial.js';
 export { partialRight } from '../function/partialRight.js';
-export { clamp } from '../math/clamp.js';
 export { inRange } from '../math/inRange.js';
 export { mean } from '../math/mean.js';
 export { meanBy } from '../math/meanBy.js';
@@ -171,6 +170,7 @@ export { repeat } from './string/repeat.js';
 export { trim } from './string/trim.js';
 export { trimStart } from './string/trimStart.js';
 export { trimEnd } from './string/trimEnd.js';
+export { clamp } from './math/clamp.js';
 export { max } from './math/max.js';
 export { min } from './math/min.js';
 export { ceil } from './math/ceil.js';

package/dist/compat/index.js

@@ -1442,6 +1442,16 @@ function trimEnd(str, chars, guard) {
     }
 }
 
+function clamp(value, bound1, bound2) {
+    if (Number.isNaN(bound1)) {
+        bound1 = 0;
+    }
+    if (Number.isNaN(bound2)) {
+        bound2 = 0;
+    }
+    return range.clamp(value, bound1, bound2);
+}
+
 function max(items = []) {
     let maxElement = items[0];
     let max = undefined;
@@ -1566,7 +1576,6 @@ exports.once = rest$1.once;
 exports.partial = rest$1.partial;
 exports.partialRight = rest$1.partialRight;
 exports.unary = rest$1.unary;
-exports.clamp = range.clamp;
 exports.inRange = range.inRange;
 exports.mean = range.mean;
 exports.meanBy = range.meanBy;
@@ -1609,6 +1618,7 @@ exports.camelCase = camelCase;
 exports.castArray = castArray;
 exports.ceil = ceil;
 exports.chunk = chunk;
+exports.clamp = clamp;
 exports.concat = concat;
 exports.conforms = conforms;
 exports.conformsTo = conformsTo;

package/dist/compat/index.mjs

@@ -57,7 +57,6 @@ export { memoize } from '../function/memoize.mjs';
 export { unary } from '../function/unary.mjs';
 export { partial } from '../function/partial.mjs';
 export { partialRight } from '../function/partialRight.mjs';
-export { clamp } from '../math/clamp.mjs';
 export { inRange } from '../math/inRange.mjs';
 export { mean } from '../math/mean.mjs';
 export { meanBy } from '../math/meanBy.mjs';
@@ -171,6 +170,7 @@ export { repeat } from './string/repeat.mjs';
 export { trim } from './string/trim.mjs';
 export { trimStart } from './string/trimStart.mjs';
 export { trimEnd } from './string/trimEnd.mjs';
+export { clamp } from './math/clamp.mjs';
 export { max } from './math/max.mjs';
 export { min } from './math/min.mjs';
 export { ceil } from './math/ceil.mjs';

package/dist/compat/math/clamp.d.mts

@@ -0,0 +1,32 @@
+/**
+ * Clamps a number within the inclusive upper bound.
+ *
+ * This function takes a number and a maximum bound, and returns the number clamped within the specified upper bound.
+ * If only one bound is provided, it returns the minimum of the value and the bound.
+ *
+ * @param {number} value - The number to clamp.
+ * @param {number} maximum - The maximum bound to clamp the number.
+ * @returns {number} The clamped number within the specified upper bound.
+ *
+ * @example
+ * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
+ */
+declare function clamp(value: number, maximum: number): number;
+/**
+ * Clamps a number within the inclusive lower and upper bounds.
+ *
+ * This function takes a number and two bounds, and returns the number clamped within the specified bounds.
+ *
+ * @param {number} value - The number to clamp.
+ * @param {number} minimum - The minimum bound to clamp the number.
+ * @param {number} maximum - The maximum bound to clamp the number.
+ * @returns {number} The clamped number within the specified bounds.
+ *
+ * @example
+ * const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15
+ * const result3 = clamp(2, 5, 15); // result3 will be 5, as 2 is clamped to the lower bound 5
+ * const result4 = clamp(20, 5, 15); // result4 will be 15, as 20 is clamped to the upper bound 15
+ */
+declare function clamp(value: number, minimum: number, maximum: number): number;
+
+export { clamp };

package/dist/compat/math/clamp.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Clamps a number within the inclusive upper bound.
+ *
+ * This function takes a number and a maximum bound, and returns the number clamped within the specified upper bound.
+ * If only one bound is provided, it returns the minimum of the value and the bound.
+ *
+ * @param {number} value - The number to clamp.
+ * @param {number} maximum - The maximum bound to clamp the number.
+ * @returns {number} The clamped number within the specified upper bound.
+ *
+ * @example
+ * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
+ */
+declare function clamp(value: number, maximum: number): number;
+/**
+ * Clamps a number within the inclusive lower and upper bounds.
+ *
+ * This function takes a number and two bounds, and returns the number clamped within the specified bounds.
+ *
+ * @param {number} value - The number to clamp.
+ * @param {number} minimum - The minimum bound to clamp the number.
+ * @param {number} maximum - The maximum bound to clamp the number.
+ * @returns {number} The clamped number within the specified bounds.
+ *
+ * @example
+ * const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15
+ * const result3 = clamp(2, 5, 15); // result3 will be 5, as 2 is clamped to the lower bound 5
+ * const result4 = clamp(20, 5, 15); // result4 will be 15, as 20 is clamped to the upper bound 15
+ */
+declare function clamp(value: number, minimum: number, maximum: number): number;
+
+export { clamp };

package/dist/compat/math/clamp.mjs

@@ -0,0 +1,13 @@
+import { clamp as clamp$1 } from '../../math/clamp.mjs';
+
+function clamp(value, bound1, bound2) {
+    if (Number.isNaN(bound1)) {
+        bound1 = 0;
+    }
+    if (Number.isNaN(bound2)) {
+        bound2 = 0;
+    }
+    return clamp$1(value, bound1, bound2);
+}
+
+export { clamp };

package/dist/math/inRange.d.mts

@@ -1,4 +1,27 @@
+/**
+ * Checks if the value is less than the maximum.
+ *
+ * @param {number} value The value to check.
+ * @param {number} maximum The upper bound of the range (exclusive).
+ * @returns {boolean} `true` if the value is less than the maximum, otherwise `false`.
+ *
+ * @example
+ * const result = inRange(3, 5); // result will be true.
+ * const result2 = inRange(5, 5); // result2 will be false.
+ */
 declare function inRange(value: number, maximum: number): boolean;
+/**
+ * Checks if the value is within the range defined by minimum (inclusive) and maximum (exclusive).
+ *
+ * @param {number} value The value to check.
+ * @param {number} minimum The lower bound of the range (inclusive).
+ * @param {number} maximum The upper bound of the range (exclusive).
+ * @returns {boolean} `true` if the value is within the specified range, otherwise `false`.
+ *
+ * @example
+ * const result = inRange(3, 2, 5); // result will be true.
+ * const result2 = inRange(1, 2, 5); // result2 will be false.
+ */
 declare function inRange(value: number, minimum: number, maximum: number): boolean;
 
 export { inRange };

package/dist/math/inRange.d.ts

@@ -1,4 +1,27 @@
+/**
+ * Checks if the value is less than the maximum.
+ *
+ * @param {number} value The value to check.
+ * @param {number} maximum The upper bound of the range (exclusive).
+ * @returns {boolean} `true` if the value is less than the maximum, otherwise `false`.
+ *
+ * @example
+ * const result = inRange(3, 5); // result will be true.
+ * const result2 = inRange(5, 5); // result2 will be false.
+ */
 declare function inRange(value: number, maximum: number): boolean;
+/**
+ * Checks if the value is within the range defined by minimum (inclusive) and maximum (exclusive).
+ *
+ * @param {number} value The value to check.
+ * @param {number} minimum The lower bound of the range (inclusive).
+ * @param {number} maximum The upper bound of the range (exclusive).
+ * @returns {boolean} `true` if the value is within the specified range, otherwise `false`.
+ *
+ * @example
+ * const result = inRange(3, 2, 5); // result will be true.
+ * const result2 = inRange(1, 2, 5); // result2 will be false.
+ */
 declare function inRange(value: number, minimum: number, maximum: number): boolean;
 
 export { inRange };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.19.0-dev.621+753ccbf9",
+  "version": "1.19.0-dev.622+192a7d59",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {