ts-data-forge 11.0.0 → 12.0.0

package/src/number/branded-types/uint32.mts

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -34,130 +34,139 @@ const {
 } as const);
 
 /**
- * Checks if a number is a Uint32 (32-bit unsigned integer in the range [0,
- * 2^32)).
+ * Type guard that checks if a value is a non-negative integer less than 2^32.
  *
- * @param value The value to check.
- * @returns `true` if the value is a Uint32, `false` otherwise.
+ * Returns `true` for a non-negative integer less than 2^32 — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative integer less than 2^32, `false` otherwise
  */
 export const isUint32 = is;
 
 /**
- * Casts a number to a Uint32 type.
+ * Casts a `number` to the `Uint32` branded type.
+ *
+ * Validates that the value is a non-negative integer less than 2^32 and returns
+ * it with the `Uint32` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a Uint32 type.
- * @throws {TypeError} If the value is not a non-negative integer less than
- *   2^32.
+ * @param value - The value to cast
+ * @returns The value as an `Uint32`
+ * @throws {TypeError} If the value is not a non-negative integer less than 2^32
  */
 export const asUint32 = castType;
 
 /**
- * Utility functions for working with Uint32 (32-bit unsigned integer) branded
- * types. Provides type-safe operations that ensure results remain within the
- * valid range [0, 2^32). All arithmetic operations are clamped to maintain the
- * Uint32 constraint.
+ * Namespace providing type-safe operations for the `Uint32` branded type.
+ *
+ * The `Uint32` type represents a non-negative integer less than 2^32. Division
+ * (`div`) uses floor division.
  */
 export const Uint32 = {
   /**
-   * Type guard that checks if a value is a 32-bit unsigned integer.
+   * Type guard that checks if a value is a non-negative integer less than 2^32.
    *
    * @param value - The value to check
-   * @returns `true` if the value is within the range [0, 2^32), `false`
-   *   otherwise
+   * @returns `true` if the value is a non-negative integer less than 2^32, `false` otherwise
+   * @see {@link isUint32} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a Uint32.
-   *
-   * @readonly
+   * The smallest value representable as `Uint32` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for a Uint32.
-   *
-   * @readonly
+   * The largest value representable as `Uint32` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
 
   /**
-   * Returns the minimum of multiple Uint32 values.
+   * Returns the smallest of the given non-negative integers.
    *
-   * @param values - The Uint32 values to compare
-   * @returns The smallest value as a Uint32
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The smallest value as an `Uint32`
    */
   min: min_,
 
   /**
-   * Returns the maximum of multiple Uint32 values.
+   * Returns the largest of the given non-negative integers.
    *
-   * @param values - The Uint32 values to compare
-   * @returns The largest value as a Uint32
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The largest value as an `Uint32`
    */
   max: max_,
 
   /**
-   * Clamps a Uint32 to be within the specified range.
+   * Converts an arbitrary `number` into an `Uint32`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asUint32`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Uint32` instead of throwing.
    *
-   * @param value - The value to clamp
-   * @param min - The minimum value
-   * @param max - The maximum value
-   * @returns The clamped value as a Uint32
+   * @param value - The value to convert
+   * @returns The value as an `Uint32`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * Generates a random Uint32 value.
+   * Generates a random `Uint32` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random Uint32 value within [0, 2^32)
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Uint32` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a Uint32 to a power, with result clamped to [0, 2^32).
+   * Raises `a` to the power `b`, returning `a ** b` as an `Uint32` (floored to
+   * an integer).
    *
-   * @param a - The base Uint32
-   * @param b - The exponent Uint32
-   * @returns `a ** b` as a Uint32, clamped to valid range
+   * @param a - The base non-negative integer
+   * @param b - The exponent non-negative integer
+   * @returns `a ** b` as an `Uint32`
    */
   pow,
 
   /**
-   * Adds two Uint32 values, with result clamped to [0, 2^32).
+   * Adds two non-negative integers, returning `a + b` as an `Uint32`.
    *
-   * @param a - First Uint32
-   * @param b - Second Uint32
-   * @returns `a + b` as a Uint32, clamped to valid range
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The sum of `a` and `b` as an `Uint32`
    */
   add,
 
   /**
-   * Subtracts two Uint32 values, with result clamped to [0, 2^32).
+   * Subtracts two non-negative integers, returning `a - b` as an `Uint32`.
    *
-   * @param a - First Uint32
-   * @param b - Second Uint32
-   * @returns `a - b` as a Uint32, clamped to valid range (minimum 0)
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The difference of `a` and `b` as an `Uint32`
    */
   sub,
 
   /**
-   * Multiplies two Uint32 values, with result clamped to [0, 2^32).
+   * Multiplies two non-negative integers, returning `a * b` as an `Uint32`.
    *
-   * @param a - First Uint32
-   * @param b - Second Uint32
-   * @returns `a * b` as a Uint32, clamped to valid range
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The product of `a` and `b` as an `Uint32`
    */
   mul,
 
   /**
-   * Divides two Uint32 values using floor division, with result clamped to [0,
-   * 2^32).
+   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as an `Uint32`.
    *
-   * @param a - The dividend Uint32
-   * @param b - The divisor Uint32
-   * @returns `⌊a / b⌋` as a Uint32, clamped to valid range
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Uint32`
    */
   div,
 } as const;

package/src/number/enum/int8.mts

@@ -14,7 +14,7 @@ const {
   MAX_VALUE,
   MIN_VALUE,
   castType: castTypeImpl,
-  clamp: clampImpl,
+  fromNumber: fromNumberImpl,
   is: isImpl,
   random: randomImpl,
 } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<
@@ -34,7 +34,7 @@ const castType = (x: number): Int8 =>
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
   castTypeImpl(x) as Int8;
 
-const clamp = (a: number): Int8 => castType(clampImpl(a));
+const fromNumber = (a: number): Int8 => castType(fromNumberImpl(a));
 
 const abs = <N extends Int8>(x: N): AbsoluteValue<N> =>
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
@@ -46,167 +46,164 @@ const min_ = (...values: readonly Int8[]): Int8 =>
 const max_ = (...values: readonly Int8[]): Int8 =>
   castType(Math.max(...values));
 
-const pow = (x: Int8, y: Int8): Int8 => clamp(x ** y);
+const pow = (x: Int8, y: Int8): Int8 => fromNumber(x ** y);
 
-const add = (x: Int8, y: Int8): Int8 => clamp(x + y);
+const add = (x: Int8, y: Int8): Int8 => fromNumber(x + y);
 
-const sub = (x: Int8, y: Int8): Int8 => clamp(x - y);
+const sub = (x: Int8, y: Int8): Int8 => fromNumber(x - y);
 
-const mul = (x: Int8, y: Int8): Int8 => clamp(x * y);
+const mul = (x: Int8, y: Int8): Int8 => fromNumber(x * y);
 
-const div = (x: Int8, y: Exclude<Int8, 0>): Int8 => clamp(Math.floor(x / y));
+const div = (x: Int8, y: Exclude<Int8, 0>): Int8 =>
+  fromNumber(Math.floor(x / y));
 
 const random = (min: Int8, max: Int8): Int8 =>
   castType(randomImpl(castTypeImpl(min), castTypeImpl(max)));
 
 /**
- * Type guard that checks if a value is an 8-bit signed integer.
+ * Type guard that checks if a value is an integer in [-128, 127].
  *
- * An Int8 is a signed integer in the range [-128, 127], representing values
- * that fit in exactly 8 bits of memory.
+ * Returns `true` for an integer in [-128, 127] — a value with no fractional
+ * component.
  *
  * @param value - The value to check
- * @returns `true` if the value is an Int8, `false` otherwise
+ * @returns `true` if the value is an integer in [-128, 127], `false` otherwise
  */
 export const isInt8 = is;
 
 /**
- * Casts a number to an Int8 branded type.
+ * Casts a `number` to the `Int8` branded type.
  *
- * This function validates that the input is within the Int8 range [-128, 127]
- * and is an integer, then returns it with the Int8 brand.
+ * Validates that the value is an integer in [-128, 127] and returns it with the
+ * `Int8` brand. Throws a `TypeError` otherwise.
  *
  * @param value - The value to cast
- * @returns The value as an Int8 branded type
- * @throws {TypeError} If the value is not a valid 8-bit signed integer
+ * @returns The value as an `Int8`
+ * @throws {TypeError} If the value is not an integer in [-128, 127]
  */
 export const asInt8 = castType;
 
 /**
- * Namespace providing type-safe operations for Int8 (8-bit signed integer)
- * branded types.
+ * Namespace providing type-safe operations for the `Int8` branded type.
  *
- * Int8 represents signed integers in the range [-128, 127], equivalent to a
- * signed byte in many programming languages. All operations automatically clamp
- * results to stay within this range, preventing overflow/underflow issues.
- *
- * This type is useful for:
- *
- * - Binary data processing (signed bytes)
- * - Small integer values with known bounds
- * - Embedded systems programming
- * - Memory-efficient integer storage
- * - Image processing (signed pixel offsets)
+ * The `Int8` type represents an integer in [-128, 127]. Division (`div`) uses
+ * floor division.
  */
 export const Int8 = {
   /**
-   * Type guard that checks if a value is an 8-bit signed integer.
+   * Type guard that checks if a value is an integer in [-128, 127].
    *
    * @param value - The value to check
-   * @returns `true` if the value is in range [-128, 127] and is an integer
+   * @returns `true` if the value is an integer in [-128, 127], `false` otherwise
    * @see {@link isInt8} for usage examples
    */
   is,
 
   /**
-   * The minimum value for an 8-bit signed integer.
-   *
-   * @readonly
+   * The smallest value representable as `Int8` (the lower saturation target of
+   * `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for an 8-bit signed integer.
-   *
-   * @readonly
+   * The largest value representable as `Int8` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
 
   /**
-   * Returns the minimum value from a list of Int8 values.
+   * Returns the smallest of the given integers.
    *
-   * @param values - The Int8 values to compare (at least one required)
-   * @returns The smallest value as an Int8
+   * @param values - The integers to compare (at least one required)
+   * @returns The smallest value as an `Int8`
    */
   min: min_,
 
   /**
-   * Returns the maximum value from a list of Int8 values.
+   * Returns the largest of the given integers.
    *
-   * @param values - The Int8 values to compare (at least one required)
-   * @returns The largest value as an Int8
+   * @param values - The integers to compare (at least one required)
+   * @returns The largest value as an `Int8`
    */
   max: max_,
 
   /**
-   * Clamps a number to the Int8 range.
+   * Converts an arbitrary `number` into an `Int8`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asInt8`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Int8` instead of throwing.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [-128, 127] as an Int8.
+   * @param value - The value to convert
+   * @returns The value as an `Int8`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * Returns the absolute value of an Int8.
+   * Returns the absolute value of an integer in [-128, 127].
+   *
+   * The result is non-negative and keeps the `Int8` brand.
    *
-   * @param value The Int8 value.
-   * @returns The absolute value as an Int8, clamped to valid range.
+   * @param a - The integer value
+   * @returns The absolute value as a non-negative `Int8`
    */
   abs,
 
   /**
-   * Generates a random Int8 value within the specified range (inclusive).
+   * Generates a random `Int8` within the given range.
    *
-   * Both bounds are inclusive. If min > max, they are automatically swapped.
+   * The range is inclusive on both ends.
    *
    * @param min - The minimum value (inclusive)
    * @param max - The maximum value (inclusive)
-   * @returns A random Int8 in the range [min, max]
+   * @returns A random `Int8` in `[min, max]`
    */
   random,
 
   /**
-   * Raises x to the power of y, clamped to Int8 range.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Int8` (floored to an
+   * integer).
    *
-   * @param x - The base
-   * @param y - The exponent
-   * @returns `x ** y` clamped to [-128, 127]
+   * @param a - The base integer
+   * @param b - The exponent integer
+   * @returns `a ** b` as an `Int8`
    */
   pow,
 
   /**
-   * Adds two Int8 values, clamped to Int8 range.
+   * Adds two integers, returning `a + b` as an `Int8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x + y` clamped to [-128, 127]
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The sum of `a` and `b` as an `Int8`
    */
   add,
 
   /**
-   * Subtracts two Int8 values, clamped to Int8 range.
+   * Subtracts two integers, returning `a - b` as an `Int8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x - y` clamped to [-128, 127]
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The difference of `a` and `b` as an `Int8`
    */
   sub,
 
   /**
-   * Multiplies two Int8 values, clamped to Int8 range.
+   * Multiplies two integers, returning `a * b` as an `Int8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x * y` clamped to [-128, 127]
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The product of `a` and `b` as an `Int8`
    */
   mul,
 
   /**
-   * Divides two Int8 values, clamped to Int8 range.
+   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+   * b` rounded toward negative infinity, as an `Int8`.
    *
-   * @param x - The dividend
-   * @param y - The divisor (cannot be 0)
-   * @returns `⌊x / y⌋` clamped to [-128, 127]
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Int8`
    */
   div,
 } as const;

package/src/number/enum/int8.test.mts

@@ -61,7 +61,7 @@ describe('Int8 test', () => {
     });
   });
 
-  describe('Int8.clamp', () => {
+  describe('Int8.fromNumber', () => {
     test.each([
       { value: -200, expected: -128 },
       { value: -128, expected: -128 },
@@ -69,9 +69,12 @@ describe('Int8 test', () => {
       { value: 127, expected: 127 },
       { value: 200, expected: 127 },
       { value: 1.5, expected: 2 },
-    ])('Int8.clamp($value) should return $expected', ({ expected, value }) => {
-      expect(Int8.clamp(value)).toBe(expected);
-    });
+    ])(
+      'Int8.fromNumber($value) should return $expected',
+      ({ expected, value }) => {
+        expect(Int8.fromNumber(value)).toBe(expected);
+      },
+    );
   });
 
   describe('Int8.min', () => {