ts-data-forge 1.5.0 → 1.5.1

package/dist/number/num.d.mts

@@ -39,10 +39,7 @@ export declare namespace Num {
      * @returns The numeric representation of `n`.
      * @example
      * ```typescript
-     * Num.from('123'); // 123
      * Num.from('123.45'); // 123.45
-     * Num.from(true); // 1
-     * Num.from(false); // 0
      * Num.from('hello'); // NaN
      * ```
      */
@@ -204,15 +201,6 @@ export declare namespace Num {
      *
      * @example
      * ```typescript
-     * // Array index validation
-     * const isValidIndex = Num.isUintInRange(0, 10);
-     * const index: number = getUserInput();
-     *
-     * if (isValidIndex(index)) {
-     *   // index is typed as 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
-     *   const value = array[index]; // Safe array access
-     * }
-     *
      * // Custom range validation
      * const isValidPercentage = Num.isUintInRange(0, 101);
      * if (isValidPercentage(value)) {
@@ -239,20 +227,12 @@ export declare namespace Num {
      *
      * @example
      * ```typescript
-     * // Score validation (0-100)
      * const isValidScore = Num.isUintInRangeInclusive(0, 100);
      * const score: number = getTestScore();
-     *
      * if (isValidScore(score)) {
      *   // score is typed as 0 | 1 | 2 | ... | 100
      *   const grade = calculateGrade(score);
      * }
-     *
-     * // Day of month validation
-     * const isValidDay = Num.isUintInRangeInclusive(1, 31);
-     * if (isValidDay(day)) {
-     *   // day is typed as 1 | 2 | ... | 31
-     * }
      * ```
      */
     export const isUintInRangeInclusive: <L extends SmallUint, U extends SmallUint>(lowerBound: L, upperBound: U) => (x: number) => x is RelaxedExclude<LEQ[U], LT[Min<L>]>;
@@ -264,37 +244,14 @@ export declare namespace Num {
      * - **Curried usage**: Pass bounds to get a reusable clamping function
      *
      * @example
-     * Direct usage:
      * ```typescript
+     * // Direct usage
      * Num.clamp(15, 0, 10); // 10 (clamped to upper bound)
-     * Num.clamp(-5, 0, 10); // 0 (clamped to lower bound)
      * Num.clamp(5, 0, 10);  // 5 (within bounds)
-     * Num.clamp(NaN, 0, 10); // 0 (invalid values default to lower bound)
-     * ```
      *
-     * @example
-     * Curried usage for reusable functions:
-     * ```typescript
+     * // Curried usage
      * const clampToPercent = Num.clamp(0, 100);
      * clampToPercent(150); // 100
-     * clampToPercent(-10); // 0
-     * clampToPercent(75);  // 75
-     *
-     * // Perfect for pipe composition
-     * const result = pipe(userInput)
-     *   .map(Number)
-     *   .map(clampToPercent).value;
-     * ```
-     *
-     * @example
-     * Working with arrays and functional programming:
-     * ```typescript
-     * const clampTo0_1 = Num.clamp(0, 1);
-     * const normalizedValues = values.map(clampTo0_1);
-     *
-     * // Temperature clamping
-     * const clampTemperature = Num.clamp(-40, 50);
-     * const safeTemperatures = readings.map(clampTemperature);
      * ```
      */
     export const clamp: ClampFnOverload;
@@ -315,11 +272,7 @@ export declare namespace Num {
      *
      * @example
      * ```typescript
-     * // Safe division with literals
-     * const result1 = Num.div(10, 2); // 5
-     * const result2 = Num.div(7, 3); // 2.3333...
-     *
-     * // Compile-time error prevention
+     * const result = Num.div(10, 2); // 5
      * // Num.div(10, 0); // ❌ TypeScript error: Type '0' is not assignable
      *
      * // With type guards
@@ -351,9 +304,6 @@ export declare namespace Num {
      * ```typescript
      * Num.divInt(10, 3);   // 3
      * Num.divInt(10, -3);  // -4 (floor division)
-     * Num.divInt(-10, 3);  // -4
-     * Num.divInt(10.7, 3.2); // 3 (floors both inputs first)
-     * Num.divInt(10, 0);   // NaN
      * ```
      */
     export const divInt: (a: number, b: NonZeroNumber | SmallInt<"!=0">) => number;
@@ -370,10 +320,7 @@ export declare namespace Num {
      * @example
      * ```typescript
      * Num.roundAt(3.14159, 2);   // 3.14
-     * Num.roundAt(3.14159, 4);   // 3.1416
      * Num.roundAt(10.5, 0);      // 11
-     * Num.roundAt(-10.5, 0);     // -10
-     * Num.roundAt(0.005, 2);     // 0.01
      * ```
      */
     export const roundAt: (num: number, precision: PositiveSafeIntWithSmallInt) => number;
@@ -391,9 +338,6 @@ export declare namespace Num {
      * ```typescript
      * Num.roundToInt(3.2);   // 3
      * Num.roundToInt(3.5);   // 4
-     * Num.roundToInt(3.8);   // 4
-     * Num.roundToInt(-3.2);  // -3
-     * Num.roundToInt(-3.8);  // -3
      * ```
      */
     export const roundToInt: (num: number) => Int;
@@ -409,19 +353,9 @@ export declare namespace Num {
      *
      * @example
      * ```typescript
-     * // Create specialized rounding functions
      * const roundTo2 = Num.round(2);
-     * const roundTo4 = Num.round(4);
-     *
      * roundTo2(3.14159);  // 3.14
      * roundTo2(2.71828);  // 2.72
-     * roundTo2(10);       // 10
-     *
-     * roundTo4(3.14159);  // 3.1416
-     *
-     * // Use with array operations
-     * const values = [1.234, 5.678, 9.012];
-     * const rounded = values.map(roundTo2); // [1.23, 5.68, 9.01]
      * ```
      */
     export const round: (digit: PositiveSafeIntWithSmallInt) => ((num: number) => number);
@@ -438,20 +372,8 @@ export declare namespace Num {
      *
      * @example
      * ```typescript
-     * Num.mapNaN2Undefined(42);           // 42
-     * Num.mapNaN2Undefined(0);            // 0
-     * Num.mapNaN2Undefined(NaN);          // undefined
-     * Num.mapNaN2Undefined(Math.sqrt(-1)); // undefined
-     *
-     * // Useful in chains
-     * const result = Num.mapNaN2Undefined(parseFloat(userInput)) ?? 0;
-     *
-     * // Type narrowing
-     * const value = Math.sqrt(x);
-     * const safe = Num.mapNaN2Undefined(value);
-     * if (safe !== undefined) {
-     *   // safe is typed without NaN
-     * }
+     * Num.mapNaN2Undefined(42);   // 42
+     * Num.mapNaN2Undefined(NaN);  // undefined
      * ```
      */
     export const mapNaN2Undefined: <N extends number>(num: N) => RelaxedExclude<N, NaNType> | undefined;
@@ -470,15 +392,6 @@ export declare namespace Num {
      * ```typescript
      * const zero = 0 as 0;
      * const one = Num.increment(zero); // type is 1, value is 1
-     *
-     * const five = 5 as 5;
-     * const six = Num.increment(five); // type is 6, value is 6
-     *
-     * // Type-safe counter
-     * type Counter<N extends SmallUint> = {
-     *   value: N;
-     *   next(): Counter<Increment<N>>;
-     * };
      * ```
      */
     export const increment: <N extends SmallUint>(n: N) => Increment<N>;
@@ -497,16 +410,6 @@ export declare namespace Num {
      * ```typescript
      * const three = 3 as 3;
      * const two = Num.decrement(three); // type is 2, value is 2
-     *
-     * const one = 1 as 1;
-     * const zero = Num.decrement(one); // type is 0, value is 0
-     *
-     * // Type-safe countdown
-     * function countdown<N extends PositiveSmallInt>(
-     *   n: N
-     * ): N extends 1 ? 0 : Decrement<N> {
-     *   return Num.decrement(n);
-     * }
      * ```
      */
     export const decrement: <N extends PositiveSmallInt>(n: N) => Decrement<N>;

package/dist/number/num.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"num.d.mts","sourceRoot":"","sources":["../../src/number/num.mts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,yBAAiB,GAAG,CAAC;IACnB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,MAAe,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,EACxC,KAAK,CAAC,KACL,GAAG,IAAI,aAAa,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,CAAc,CAAC;IAI5D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,EAC5C,KAAK,CAAC,KACL,GAAG,IAAI,iBAAiB,GAAG,cAAc,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CACzD,CAAC;IAEX;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,EACzC,KAAK,CAAC,KACL,GAAG,IAAI,cAAc,GAAG,cAAc,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,CAAC;IAEV;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,SAAS,GACnB,YAAY,MAAM,EAAE,YAAY,MAAM,MACtC,GAAG,MAAM,KAAG,OACsB,CAAC;IAEtC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,kBAAkB,GAC5B,YAAY,MAAM,EAAE,YAAY,MAAM,MACtC,GAAG,MAAM,KAAG,OACuB,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,KAAK,EAAE,GAAG;SACP,CAAC,IAAI,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC;KAC3B,CAAC;IAEF;;;;;;;;;;OAUG;IACH,KAAK,GAAG,GAAG;SACR,CAAC,IAAI,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;KAC/B,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,MAAM,aAAa,GACvB,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,MACtE,GAAG,MAAM,KAAG,CAAC,IAAI,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CACY,CAAC;IAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,MAAM,sBAAsB,GAChC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,MACtE,GAAG,MAAM,KAAG,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CACY,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IAEH,MAAM,CAAC,MAAM,KAAK,EAAE,eAmBC,CAAC;IAEtB,KAAK,eAAe,GAAG;QACrB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;QAGjE,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;KACtE,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,MAAM,GAAG,GAAI,GAAG,MAAM,EAAE,GAAG,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAG,MAC7D,CAAC;IAER;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,MAAM,MAAM,GACjB,GAAG,MAAM,EACT,GAAG,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,KACjC,MAAmD,CAAC;IAEvD;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,OAAO,GAClB,KAAK,MAAM,EACX,WAAW,2BAA2B,KACrC,MAIF,CAAC;IAEF;;;;;;;;;;;;;;;;;;OAkBG;IAEH,MAAM,CAAC,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,GAA+B,CAAC;IAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,MAAM,KAAK,GAChB,OAAO,2BAA2B,KACjC,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAI1B,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CAAC,MAAM,gBAAgB,GAAI,CAAC,SAAS,MAAM,EAC/C,KAAK,CAAC,KACL,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,SAIS,CAAC;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,SAAS,EAAE,GAAG,CAAC,KAAG,SAAS,CAAC,CAAC,CAExC,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,gBAAgB,EAAE,GAAG,CAAC,KAAG,SAAS,CAAC,CAAC,CAE/C,CAAC;;CAC3B"}
+{"version":3,"file":"num.d.mts","sourceRoot":"","sources":["../../src/number/num.mts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,yBAAiB,GAAG,CAAC;IACnB;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,MAAe,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,EACxC,KAAK,CAAC,KACL,GAAG,IAAI,aAAa,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,CAAc,CAAC;IAI5D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,EAC5C,KAAK,CAAC,KACL,GAAG,IAAI,iBAAiB,GAAG,cAAc,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CACzD,CAAC;IAEX;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,EACzC,KAAK,CAAC,KACL,GAAG,IAAI,cAAc,GAAG,cAAc,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,CAAC;IAEV;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,SAAS,GACnB,YAAY,MAAM,EAAE,YAAY,MAAM,MACtC,GAAG,MAAM,KAAG,OACsB,CAAC;IAEtC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,kBAAkB,GAC5B,YAAY,MAAM,EAAE,YAAY,MAAM,MACtC,GAAG,MAAM,KAAG,OACuB,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,KAAK,EAAE,GAAG;SACP,CAAC,IAAI,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC;KAC3B,CAAC;IAEF;;;;;;;;;;OAUG;IACH,KAAK,GAAG,GAAG;SACR,CAAC,IAAI,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;KAC/B,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAAM,aAAa,GACvB,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,MACtE,GAAG,MAAM,KAAG,CAAC,IAAI,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CACY,CAAC;IAEjE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,MAAM,sBAAsB,GAChC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,MACtE,GAAG,MAAM,KAAG,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CACY,CAAC;IAElE;;;;;;;;;;;;;;;;;OAiBG;IAEH,MAAM,CAAC,MAAM,KAAK,EAAE,eAmBC,CAAC;IAEtB,KAAK,eAAe,GAAG;QACrB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAAC;QAGjE,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;KACtE,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,MAAM,GAAG,GAAI,GAAG,MAAM,EAAE,GAAG,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAG,MAC7D,CAAC;IAER;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,MAAM,MAAM,GACjB,GAAG,MAAM,EACT,GAAG,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,KACjC,MAAmD,CAAC;IAEvD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,OAAO,GAClB,KAAK,MAAM,EACX,WAAW,2BAA2B,KACrC,MAIF,CAAC;IAEF;;;;;;;;;;;;;;;OAeG;IAEH,MAAM,CAAC,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,GAA+B,CAAC;IAEzE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,MAAM,KAAK,GAChB,OAAO,2BAA2B,KACjC,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAI1B,CAAC;IAEF;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,MAAM,gBAAgB,GAAI,CAAC,SAAS,MAAM,EAC/C,KAAK,CAAC,KACL,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,SAIS,CAAC;IAE1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,SAAS,EAAE,GAAG,CAAC,KAAG,SAAS,CAAC,CAAC,CAExC,CAAC;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,MAAM,SAAS,GAAI,CAAC,SAAS,gBAAgB,EAAE,GAAG,CAAC,KAAG,SAAS,CAAC,CAAC,CAE/C,CAAC;;CAC3B"}

package/dist/number/num.mjs

@@ -40,10 +40,7 @@ var Num;
      * @returns The numeric representation of `n`.
      * @example
      * ```typescript
-     * Num.from('123'); // 123
      * Num.from('123.45'); // 123.45
-     * Num.from(true); // 1
-     * Num.from(false); // 0
      * Num.from('hello'); // NaN
      * ```
      */
@@ -177,15 +174,6 @@ var Num;
      *
      * @example
      * ```typescript
-     * // Array index validation
-     * const isValidIndex = Num.isUintInRange(0, 10);
-     * const index: number = getUserInput();
-     *
-     * if (isValidIndex(index)) {
-     *   // index is typed as 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
-     *   const value = array[index]; // Safe array access
-     * }
-     *
      * // Custom range validation
      * const isValidPercentage = Num.isUintInRange(0, 101);
      * if (isValidPercentage(value)) {
@@ -212,20 +200,12 @@ var Num;
      *
      * @example
      * ```typescript
-     * // Score validation (0-100)
      * const isValidScore = Num.isUintInRangeInclusive(0, 100);
      * const score: number = getTestScore();
-     *
      * if (isValidScore(score)) {
      *   // score is typed as 0 | 1 | 2 | ... | 100
      *   const grade = calculateGrade(score);
      * }
-     *
-     * // Day of month validation
-     * const isValidDay = Num.isUintInRangeInclusive(1, 31);
-     * if (isValidDay(day)) {
-     *   // day is typed as 1 | 2 | ... | 31
-     * }
      * ```
      */
     Num.isUintInRangeInclusive = (lowerBound, upperBound) => (x) => Number.isSafeInteger(x) && lowerBound <= x && x <= upperBound;
@@ -237,37 +217,14 @@ var Num;
      * - **Curried usage**: Pass bounds to get a reusable clamping function
      *
      * @example
-     * Direct usage:
      * ```typescript
+     * // Direct usage
      * Num.clamp(15, 0, 10); // 10 (clamped to upper bound)
-     * Num.clamp(-5, 0, 10); // 0 (clamped to lower bound)
      * Num.clamp(5, 0, 10);  // 5 (within bounds)
-     * Num.clamp(NaN, 0, 10); // 0 (invalid values default to lower bound)
-     * ```
      *
-     * @example
-     * Curried usage for reusable functions:
-     * ```typescript
+     * // Curried usage
      * const clampToPercent = Num.clamp(0, 100);
      * clampToPercent(150); // 100
-     * clampToPercent(-10); // 0
-     * clampToPercent(75);  // 75
-     *
-     * // Perfect for pipe composition
-     * const result = pipe(userInput)
-     *   .map(Number)
-     *   .map(clampToPercent).value;
-     * ```
-     *
-     * @example
-     * Working with arrays and functional programming:
-     * ```typescript
-     * const clampTo0_1 = Num.clamp(0, 1);
-     * const normalizedValues = values.map(clampTo0_1);
-     *
-     * // Temperature clamping
-     * const clampTemperature = Num.clamp(-40, 50);
-     * const safeTemperatures = readings.map(clampTemperature);
      * ```
      */
     // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
@@ -298,11 +255,7 @@ var Num;
      *
      * @example
      * ```typescript
-     * // Safe division with literals
-     * const result1 = Num.div(10, 2); // 5
-     * const result2 = Num.div(7, 3); // 2.3333...
-     *
-     * // Compile-time error prevention
+     * const result = Num.div(10, 2); // 5
      * // Num.div(10, 0); // ❌ TypeScript error: Type '0' is not assignable
      *
      * // With type guards
@@ -334,9 +287,6 @@ var Num;
      * ```typescript
      * Num.divInt(10, 3);   // 3
      * Num.divInt(10, -3);  // -4 (floor division)
-     * Num.divInt(-10, 3);  // -4
-     * Num.divInt(10.7, 3.2); // 3 (floors both inputs first)
-     * Num.divInt(10, 0);   // NaN
      * ```
      */
     Num.divInt = (a, b) => Math.floor(Math.floor(a) / Math.floor(b));
@@ -353,10 +303,7 @@ var Num;
      * @example
      * ```typescript
      * Num.roundAt(3.14159, 2);   // 3.14
-     * Num.roundAt(3.14159, 4);   // 3.1416
      * Num.roundAt(10.5, 0);      // 11
-     * Num.roundAt(-10.5, 0);     // -10
-     * Num.roundAt(0.005, 2);     // 0.01
      * ```
      */
     Num.roundAt = (num, precision) => {
@@ -377,9 +324,6 @@ var Num;
      * ```typescript
      * Num.roundToInt(3.2);   // 3
      * Num.roundToInt(3.5);   // 4
-     * Num.roundToInt(3.8);   // 4
-     * Num.roundToInt(-3.2);  // -3
-     * Num.roundToInt(-3.8);  // -3
      * ```
      */
     // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
@@ -396,19 +340,9 @@ var Num;
      *
      * @example
      * ```typescript
-     * // Create specialized rounding functions
      * const roundTo2 = Num.round(2);
-     * const roundTo4 = Num.round(4);
-     *
      * roundTo2(3.14159);  // 3.14
      * roundTo2(2.71828);  // 2.72
-     * roundTo2(10);       // 10
-     *
-     * roundTo4(3.14159);  // 3.1416
-     *
-     * // Use with array operations
-     * const values = [1.234, 5.678, 9.012];
-     * const rounded = values.map(roundTo2); // [1.23, 5.68, 9.01]
      * ```
      */
     Num.round = (digit) => {
@@ -428,20 +362,8 @@ var Num;
      *
      * @example
      * ```typescript
-     * Num.mapNaN2Undefined(42);           // 42
-     * Num.mapNaN2Undefined(0);            // 0
-     * Num.mapNaN2Undefined(NaN);          // undefined
-     * Num.mapNaN2Undefined(Math.sqrt(-1)); // undefined
-     *
-     * // Useful in chains
-     * const result = Num.mapNaN2Undefined(parseFloat(userInput)) ?? 0;
-     *
-     * // Type narrowing
-     * const value = Math.sqrt(x);
-     * const safe = Num.mapNaN2Undefined(value);
-     * if (safe !== undefined) {
-     *   // safe is typed without NaN
-     * }
+     * Num.mapNaN2Undefined(42);   // 42
+     * Num.mapNaN2Undefined(NaN);  // undefined
      * ```
      */
     Num.mapNaN2Undefined = (num) => Number.isNaN(num)
@@ -463,15 +385,6 @@ var Num;
      * ```typescript
      * const zero = 0 as 0;
      * const one = Num.increment(zero); // type is 1, value is 1
-     *
-     * const five = 5 as 5;
-     * const six = Num.increment(five); // type is 6, value is 6
-     *
-     * // Type-safe counter
-     * type Counter<N extends SmallUint> = {
-     *   value: N;
-     *   next(): Counter<Increment<N>>;
-     * };
      * ```
      */
     Num.increment = (n) => 
@@ -492,16 +405,6 @@ var Num;
      * ```typescript
      * const three = 3 as 3;
      * const two = Num.decrement(three); // type is 2, value is 2
-     *
-     * const one = 1 as 1;
-     * const zero = Num.decrement(one); // type is 0, value is 0
-     *
-     * // Type-safe countdown
-     * function countdown<N extends PositiveSmallInt>(
-     *   n: N
-     * ): N extends 1 ? 0 : Decrement<N> {
-     *   return Num.decrement(n);
-     * }
      * ```
      */
     Num.decrement = (n) => 

package/dist/number/num.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"num.mjs","sources":["../../src/number/num.mts"],"sourcesContent":[null],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCG;IACc;AAAjB,CAAA,UAAiB,GAAG,EAAA;AAClB;;;;;;;;;;;;AAYG;IACU,GAAA,CAAA,IAAI,GAA2B,MAAM;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;IACU,GAAA,CAAA,SAAS,GAAG,CACvB,GAAM,KAC0C,GAAG,KAAK,CAAC;AAI3D;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;IACU,GAAA,CAAA,aAAa,GAAG,CAC3B,GAAM,KAEN,GAAG,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;IACU,GAAA,CAAA,UAAU,GAAG,CACxB,GAAM,KAEN,GAAG,GAAG,CAAC;AAET;;;;;;;;;;;;;AAaG;IACU,GAAA,CAAA,SAAS,GACpB,CAAC,UAAkB,EAAE,UAAkB,KACvC,CAAC,CAAS,KACR,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU;AAErC;;;;;;;;;;;;;AAaG;IACU,GAAA,CAAA,kBAAkB,GAC7B,CAAC,UAAkB,EAAE,UAAkB,KACvC,CAAC,CAAS,KACR,UAAU,IAAI,CAAC,IAAI,CAAC,IAAI,UAAU;AAgCtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCG;IACU,GAAA,CAAA,aAAa,GACxB,CAA2C,UAAa,EAAE,UAAa,KACvE,CAAC,CAAS,KACR,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCG;IACU,GAAA,CAAA,sBAAsB,GACjC,CAA2C,UAAa,EAAE,UAAa,KACvE,CAAC,CAAS,KACR,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,IAAI,UAAU;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCG;;AAEU,IAAA,GAAA,CAAA,KAAK,IAAqB,CACrC,GAAG,IAEkD,KACnD;AACF,QAAA,QAAQ,IAAI,CAAC,MAAM;YACjB,KAAK,CAAC,EAAE;gBACN,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,IAAI;AAC7C,gBAAA,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM;AAC5B,sBAAE;AACF,sBAAE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;;YAGxD,KAAK,CAAC,EAAE;AACN,gBAAA,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,IAAI;AACrC,gBAAA,OAAO,CAAC,MAAc,KACpB,GAAA,CAAA,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC;;;AAG7C,KAAC,CAAoB;AASrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BG;IACU,GAAA,CAAA,GAAG,GAAG,CAAC,CAAS,EAAE,CAAkC,KAC/D,CAAC,GAAG,CAAC;AAEP;;;;;;;;;;;;;;;;;;;;;AAqBG;IACU,GAAA,CAAA,MAAM,GAAG,CACpB,CAAS,EACT,CAAkC,KACvB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;;;;AAkBG;AACU,IAAA,GAAA,CAAA,OAAO,GAAG,CACrB,GAAW,EACX,SAAsC,KAC5B;AACV,QAAA,MAAM,KAAK,GAAG,EAAE,IAAI,SAAS;QAE7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,KAAK;AACxC,KAAC;AAED;;;;;;;;;;;;;;;;;;AAkBG;;AAEU,IAAA,GAAA,CAAA,UAAU,GAAG,CAAC,GAAW,MAAW,CAAC,IAAI,GAAG,GAAG,GAAG,CAAC,CAAQ;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BG;AACU,IAAA,GAAA,CAAA,KAAK,GAAG,CACnB,KAAkC,KACL;AAC7B,QAAA,MAAM,SAAS,GAAG,EAAE,IAAI,KAAK;AAE7B,QAAA,OAAO,CAAC,MAAc,KAAK,GAAA,CAAA,UAAU,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,SAAS;AACvE,KAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BG;IACU,GAAA,CAAA,gBAAgB,GAAG,CAC9B,GAAM,KAEN,MAAM,CAAC,KAAK,CAAC,GAAG;AACd,UAAE;AACF;AACG,YAAA,GAAkC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;AACU,IAAA,GAAA,CAAA,SAAS,GAAG,CAAsB,CAAI;;AAEjD,KAAC,CAAC,GAAG,CAAC,CAAiB;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BG;AACU,IAAA,GAAA,CAAA,SAAS,GAAG,CAA6B,CAAI;;AAExD,KAAC,CAAC,GAAG,CAAC,CAAiB;AAC3B,CAAC,EAzjBgB,GAAG,KAAH,GAAG,GAAA,EAAA,CAAA,CAAA;;;;"}
+{"version":3,"file":"num.mjs","sources":["../../src/number/num.mts"],"sourcesContent":[null],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCG;IACc;AAAjB,CAAA,UAAiB,GAAG,EAAA;AAClB;;;;;;;;;AASG;IACU,GAAA,CAAA,IAAI,GAA2B,MAAM;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;IACU,GAAA,CAAA,SAAS,GAAG,CACvB,GAAM,KAC0C,GAAG,KAAK,CAAC;AAI3D;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;IACU,GAAA,CAAA,aAAa,GAAG,CAC3B,GAAM,KAEN,GAAG,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;IACU,GAAA,CAAA,UAAU,GAAG,CACxB,GAAM,KAEN,GAAG,GAAG,CAAC;AAET;;;;;;;;;;;;;AAaG;IACU,GAAA,CAAA,SAAS,GACpB,CAAC,UAAkB,EAAE,UAAkB,KACvC,CAAC,CAAS,KACR,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU;AAErC;;;;;;;;;;;;;AAaG;IACU,GAAA,CAAA,kBAAkB,GAC7B,CAAC,UAAkB,EAAE,UAAkB,KACvC,CAAC,CAAS,KACR,UAAU,IAAI,CAAC,IAAI,CAAC,IAAI,UAAU;AAgCtC;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;IACU,GAAA,CAAA,aAAa,GACxB,CAA2C,UAAa,EAAE,UAAa,KACvE,CAAC,CAAS,KACR,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;IACU,GAAA,CAAA,sBAAsB,GACjC,CAA2C,UAAa,EAAE,UAAa,KACvE,CAAC,CAAS,KACR,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,CAAC,IAAI,CAAC,IAAI,UAAU;AAEjE;;;;;;;;;;;;;;;;;AAiBG;;AAEU,IAAA,GAAA,CAAA,KAAK,IAAqB,CACrC,GAAG,IAEkD,KACnD;AACF,QAAA,QAAQ,IAAI,CAAC,MAAM;YACjB,KAAK,CAAC,EAAE;gBACN,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,IAAI;AAC7C,gBAAA,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM;AAC5B,sBAAE;AACF,sBAAE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;;YAGxD,KAAK,CAAC,EAAE;AACN,gBAAA,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,IAAI;AACrC,gBAAA,OAAO,CAAC,MAAc,KACpB,GAAA,CAAA,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC;;;AAG7C,KAAC,CAAoB;AASrB;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BG;IACU,GAAA,CAAA,GAAG,GAAG,CAAC,CAAS,EAAE,CAAkC,KAC/D,CAAC,GAAG,CAAC;AAEP;;;;;;;;;;;;;;;;;;AAkBG;IACU,GAAA,CAAA,MAAM,GAAG,CACpB,CAAS,EACT,CAAkC,KACvB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;AAeG;AACU,IAAA,GAAA,CAAA,OAAO,GAAG,CACrB,GAAW,EACX,SAAsC,KAC5B;AACV,QAAA,MAAM,KAAK,GAAG,EAAE,IAAI,SAAS;QAE7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,KAAK;AACxC,KAAC;AAED;;;;;;;;;;;;;;;AAeG;;AAEU,IAAA,GAAA,CAAA,UAAU,GAAG,CAAC,GAAW,MAAW,CAAC,IAAI,GAAG,GAAG,GAAG,CAAC,CAAQ;AAExE;;;;;;;;;;;;;;;;AAgBG;AACU,IAAA,GAAA,CAAA,KAAK,GAAG,CACnB,KAAkC,KACL;AAC7B,QAAA,MAAM,SAAS,GAAG,EAAE,IAAI,KAAK;AAE7B,QAAA,OAAO,CAAC,MAAc,KAAK,GAAA,CAAA,UAAU,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,SAAS;AACvE,KAAC;AAED;;;;;;;;;;;;;;;;AAgBG;IACU,GAAA,CAAA,gBAAgB,GAAG,CAC9B,GAAM,KAEN,MAAM,CAAC,KAAK,CAAC,GAAG;AACd,UAAE;AACF;AACG,YAAA,GAAkC;AAEzC;;;;;;;;;;;;;;;;AAgBG;AACU,IAAA,GAAA,CAAA,SAAS,GAAG,CAAsB,CAAI;;AAEjD,KAAC,CAAC,GAAG,CAAC,CAAiB;AAEzB;;;;;;;;;;;;;;;;AAgBG;AACU,IAAA,GAAA,CAAA,SAAS,GAAG,CAA6B,CAAI;;AAExD,KAAC,CAAC,GAAG,CAAC,CAAiB;AAC3B,CAAC,EAxdgB,GAAG,KAAH,GAAG,GAAA,EAAA,CAAA,CAAA;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-data-forge",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "private": false,
   "keywords": [
     "typescript",

package/src/array/array-utils.mts

@@ -2112,72 +2112,15 @@ export namespace Arr {
    *
    * @example
    * ```typescript
-   * // Basic element finding
    * const numbers = [1, 2, 3, 4, 5];
    * const firstEven = Arr.find(numbers, x => x % 2 === 0);
    * if (Optional.isSome(firstEven)) {
-   *   console.log(firstEven.value); // 2 - first even number
+   *   console.log(firstEven.value); // 2
    * }
    *
-   * // Finding with index information
-   * const findLargeAtEnd = Arr.find(numbers, (value, index) => value > 3 && index > 2);
-   * // Optional.Some(4) - first number > 3 after index 2
-   *
-   * // Finding objects by property
-   * const users = [
-   *   { id: 1, name: 'Alice', age: 25 },
-   *   { id: 2, name: 'Bob', age: 30 },
-   *   { id: 3, name: 'Charlie', age: 35 }
-   * ];
-   *
+   * const users = [{ id: 1, name: 'Alice', age: 25 }, { id: 2, name: 'Bob', age: 30 }];
    * const adult = Arr.find(users, user => user.age >= 30);
    * // Optional.Some({ id: 2, name: 'Bob', age: 30 })
-   *
-   * const nonExistent = Arr.find(users, user => user.age > 100);
-   * // Optional.None
-   *
-   * // Empty array handling
-   * const emptyResult = Arr.find([], x => x > 0); // Optional.None
-   *
-   * // Curried usage for functional composition
-   * const findNegative = Arr.find((x: number) => x < 0);
-   * const findLongString = Arr.find((s: string) => s.length > 5);
-   *
-   * const datasets = [
-   *   [1, 2, -3, 4],
-   *   [5, 6, 7, 8],
-   *   [-1, 0, 1]
-   * ];
-   *
-   * const negativeNumbers = datasets.map(findNegative);
-   * // [Optional.Some(-3), Optional.None, Optional.Some(-1)]
-   *
-   * // Pipe composition
-   * const result = pipe(['short', 'medium', 'very long string'])
-   *   .map(findLongString)
-   *   .map(opt => Optional.unwrapOr(opt, 'default'))
-   *   .value; // 'very long string'
-   *
-   * // Complex predicate with all parameters
-   * const findSpecial = (arr: readonly number[]) =>
-   *   Arr.find(arr, (value, index, array) => {
-   *     return value > 10 && index > 0 && index < array.length - 1;
-   *   });
-   *
-   * const hasMiddleSpecial = findSpecial([5, 15, 20, 3]);
-   * // Optional.Some(15) - first value > 10 that's not at start or end
-   *
-   * // Safe unwrapping patterns
-   * const maybeFound = Arr.find(numbers, x => x > 10);
-   * const foundOrDefault = Optional.unwrapOr(maybeFound, 0); // 0 (not found)
-   * const foundOrThrow = Optional.isSome(maybeFound)
-   *   ? maybeFound.value
-   *   : (() => { throw new Error('Not found'); })();
-   *
-   * // Type inference examples
-   * expectType<typeof firstEven, Optional<number>>('=');
-   * expectType<typeof adult, Optional<{id: number, name: string, age: number}>>('=');
-   * expectType<typeof findNegative, (array: readonly number[]) => Optional<number>>('=');
    * ```
    *
    * @see {@link findIndex} for finding the index instead of the element
@@ -2564,13 +2507,8 @@ export namespace Arr {
    * @returns The single value that results from the reduction.
    * @example
    * ```ts
-   * // Regular usage
    * Arr.foldl([1, 2, 3], (sum, n) => sum + n, 0); // 6
-   *
-   * // Curried usage for pipe composition
-   * const sumWithZero = Arr.foldl((sum: number, n: number) => sum + n, 0);
-   * const result = pipe([1, 2, 3, 4]).map(sumWithZero).value;
-   * console.log(result); // 10
+   * Arr.foldl(['a', 'b', 'c'], (acc, str) => acc + str.toUpperCase(), ''); // 'ABC'
    * ```
    */
   export const foldl: FoldlFnOverload = <E, P>(
@@ -3245,13 +3183,8 @@ export namespace Arr {
    * @returns An array of arrays, where each inner array has up to `chunkSize` elements.
    * @example
    * ```ts
-   * // Regular usage
    * Arr.partition([1, 2, 3, 4, 5, 6], 2); // [[1, 2], [3, 4], [5, 6]]
-   *
-   * // Curried usage for pipe composition
-   * const chunkBy3 = Arr.partition(3);
-   * const result = pipe([1, 2, 3, 4, 5, 6, 7]).map(chunkBy3).value;
-   * console.log(result); // [[1, 2, 3], [4, 5, 6], [7]]
+   * Arr.partition([1, 2, 3, 4, 5, 6, 7], 3); // [[1, 2, 3], [4, 5, 6], [7]]
    * ```
    */
   // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
@@ -3762,7 +3695,6 @@ export namespace Arr {
    * @example
    * ```ts
    * Arr.uniq([1, 2, 2, 3, 1, 4]); // [1, 2, 3, 4]
-   * Arr.uniq(['a', 'b', 'a']); // ['a', 'b']
    * ```
    */
   export const uniq = <P extends Primitive>(