ts-data-forge 11.0.0 → 12.0.0

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

@@ -12,8 +12,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -33,7 +33,11 @@ const {
 } as const);
 
 /**
- * Checks if a number is a Uint.
+ * Type guard that checks if a value is a non-negative integer.
+ *
+ * Returns `true` for a non-negative integer — a value with no fractional
+ * component, including values outside the safe integer range (unlike
+ * `SafeInt`).
  *
  * @example
  *
@@ -45,13 +49,16 @@ const {
  * assert.isTrue(Uint.is(0));
  * ```
  *
- * @param value The value to check.
- * @returns `true` if the value is a Uint, `false` otherwise.
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative integer, `false` otherwise
  */
 export const isUint = is;
 
 /**
- * Casts a number to a Uint type.
+ * Casts a `number` to the `Uint` branded type.
+ *
+ * Validates that the value is a non-negative integer and returns it with the
+ * `Uint` brand. Throws a `TypeError` otherwise.
  *
  * @example
  *
@@ -63,22 +70,25 @@ export const isUint = is;
  * assert.isTrue(Uint.is(branded));
  * ```
  *
- * @param value The value to cast.
- * @returns The value as a Uint type.
- * @throws {TypeError} If the value is not a non-negative integer.
+ * @param value - The value to cast
+ * @returns The value as an `Uint`
+ * @throws {TypeError} If the value is not a non-negative integer
  */
 export const asUint = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for unsigned integers.
+ * Namespace providing type-safe operations for the `Uint` branded type.
+ *
+ * The `Uint` type represents a non-negative integer. Division (`div`) uses
+ * floor division.
  *
- * All operations maintain the non-negative constraint by clamping negative
- * results to 0. This ensures that all arithmetic preserves the unsigned integer
- * property.
+ * Unlike `SafeInt`, `Uint` allows values outside the safe integer range (±2^53
+ * − 1), so very large magnitudes may lose precision in JavaScript's `number`
+ * type.
  */
 export const Uint = {
   /**
-   * Type guard to check if a value is a Uint.
+   * Type guard that checks if a value is a non-negative integer.
    *
    * @example
    *
@@ -90,21 +100,20 @@ export const Uint = {
    * assert.isTrue(Uint.is(0));
    * ```
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-negative integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-negative integer, `false` otherwise
    * @see {@link isUint} for usage examples
    */
   is,
 
   /**
-   * The minimum value for an unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `Uint` (the lower saturation target of
+   * `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * Returns the smaller of two Uint values.
+   * Returns the smallest of the given non-negative integers.
    *
    * @example
    *
@@ -114,14 +123,13 @@ export const Uint = {
    * assert.isTrue(smallest === 3);
    * ```
    *
-   * @param a The first Uint.
-   * @param b The second Uint.
-   * @returns The minimum value as a Uint.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The smallest value as an `Uint`
    */
   min: min_,
 
   /**
-   * Returns the larger of two Uint values.
+   * Returns the largest of the given non-negative integers.
    *
    * @example
    *
@@ -131,34 +139,39 @@ export const Uint = {
    * assert.isTrue(largest === 7);
    * ```
    *
-   * @param a The first Uint.
-   * @param b The second Uint.
-   * @returns The maximum value as a Uint.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The largest value as an `Uint`
    */
   max: max_,
 
   /**
-   * Clamps a number to the Uint range (non-negative).
+   * Converts an arbitrary `number` into an `Uint`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asUint`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Uint` instead of throwing.
    *
    * @example
    *
    * ```ts
-   * const clampedNegative = Uint.clamp(-5);
+   * const fromNegative = Uint.fromNumber(-5);
    *
-   * const clampedPositive = Uint.clamp(42);
+   * const fromPositive = Uint.fromNumber(42);
    *
-   * assert.isTrue(clampedNegative === 0);
+   * assert.isTrue(fromNegative === 0);
    *
-   * assert.isTrue(clampedPositive === 42);
+   * assert.isTrue(fromPositive === 42);
    * ```
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, +∞) as a Uint.
+   * @param value - The value to convert
+   * @returns The value as an `Uint`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * Generates a random Uint value.
+   * Generates a random `Uint` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -174,12 +187,15 @@ export const Uint = {
    * assert.isTrue(randomValue >= 0 && randomValue <= 3);
    * ```
    *
-   * @returns A random non-negative integer as a Uint.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Uint` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a Uint to the power of another Uint.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Uint` (floored to an
+   * integer).
    *
    * @example
    *
@@ -193,14 +209,14 @@ export const Uint = {
    * assert.isTrue(power === 32);
    * ```
    *
-   * @param a The base Uint.
-   * @param b The exponent Uint.
-   * @returns `a ** b` clamped to [0, +∞) as a Uint.
+   * @param a - The base non-negative integer
+   * @param b - The exponent non-negative integer
+   * @returns `a ** b` as an `Uint`
    */
   pow,
 
   /**
-   * Adds two Uint values.
+   * Adds two non-negative integers, returning `a + b` as an `Uint`.
    *
    * @example
    *
@@ -210,14 +226,14 @@ export const Uint = {
    * assert.isTrue(sum === 13);
    * ```
    *
-   * @param a The first Uint.
-   * @param b The second Uint.
-   * @returns `a + b` clamped to [0, +∞) as a Uint.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The sum of `a` and `b` as an `Uint`
    */
   add,
 
   /**
-   * Subtracts one Uint from another.
+   * Subtracts two non-negative integers, returning `a - b` as an `Uint`.
    *
    * @example
    *
@@ -227,14 +243,14 @@ export const Uint = {
    * assert.isTrue(difference === 0);
    * ```
    *
-   * @param a The minuend Uint.
-   * @param b The subtrahend Uint.
-   * @returns `a - b` clamped to [0, +∞) as a Uint (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 `Uint`
    */
   sub,
 
   /**
-   * Multiplies two Uint values.
+   * Multiplies two non-negative integers, returning `a * b` as an `Uint`.
    *
    * @example
    *
@@ -244,14 +260,15 @@ export const Uint = {
    * assert.isTrue(product === 42);
    * ```
    *
-   * @param a The first Uint.
-   * @param b The second Uint.
-   * @returns `a * b` clamped to [0, +∞) as a Uint.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The product of `a` and `b` as an `Uint`
    */
   mul,
 
   /**
-   * Divides one Uint by another using floor division.
+   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as an `Uint`.
    *
    * @example
    *
@@ -261,9 +278,9 @@ export const Uint = {
    * assert.isTrue(quotient === 2);
    * ```
    *
-   * @param a The dividend Uint.
-   * @param b The divisor Uint.
-   * @returns `⌊a / b⌋` clamped to [0, +∞) as a Uint.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Uint`
    */
   div,
 } as const;

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

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -34,132 +34,139 @@ const {
 } as const);
 
 /**
- * Checks if a number is a Uint16 (16-bit unsigned integer in the range [0,
- * 2^16)).
+ * Type guard that checks if a value is a non-negative integer less than 2^16.
  *
- * @param value The value to check.
- * @returns `true` if the value is a Uint16, `false` otherwise.
+ * Returns `true` for a non-negative integer less than 2^16 — 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^16, `false` otherwise
  */
 export const isUint16 = is;
 
 /**
- * Casts a number to a Uint16 type.
+ * Casts a `number` to the `Uint16` branded type.
+ *
+ * Validates that the value is a non-negative integer less than 2^16 and returns
+ * it with the `Uint16` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a Uint16 type.
- * @throws {TypeError} If the value is not a non-negative integer less than
- *   2^16.
+ * @param value - The value to cast
+ * @returns The value as an `Uint16`
+ * @throws {TypeError} If the value is not a non-negative integer less than 2^16
  */
 export const asUint16 = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for 16-bit unsigned
- * integers.
+ * Namespace providing type-safe operations for the `Uint16` branded type.
  *
- * All operations automatically clamp results to the valid Uint16 range [0,
- * 65535]. This ensures that all arithmetic maintains the 16-bit unsigned
- * integer constraint, with negative results clamped to 0 and overflow results
- * clamped to MAX_VALUE.
+ * The `Uint16` type represents a non-negative integer less than 2^16. Division
+ * (`div`) uses floor division.
  */
 export const Uint16 = {
   /**
-   * Type guard to check if a value is a Uint16.
+   * Type guard that checks if a value is a non-negative integer less than 2^16.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 16-bit unsigned integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-negative integer less than 2^16, `false` otherwise
+   * @see {@link isUint16} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a 16-bit unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `Uint16` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for a 16-bit unsigned integer.
-   *
-   * @readonly
+   * The largest value representable as `Uint16` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
 
   /**
-   * Returns the smaller of two Uint16 values.
+   * Returns the smallest of the given non-negative integers.
    *
-   * @param a The first Uint16.
-   * @param b The second Uint16.
-   * @returns The minimum value as a Uint16.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The smallest value as an `Uint16`
    */
   min: min_,
 
   /**
-   * Returns the larger of two Uint16 values.
+   * Returns the largest of the given non-negative integers.
    *
-   * @param a The first Uint16.
-   * @param b The second Uint16.
-   * @returns The maximum value as a Uint16.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The largest value as an `Uint16`
    */
   max: max_,
 
   /**
-   * Clamps a number to the Uint16 range.
+   * Converts an arbitrary `number` into an `Uint16`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asUint16`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Uint16` instead of throwing.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, 65535] as a Uint16.
+   * @param value - The value to convert
+   * @returns The value as an `Uint16`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * Generates a random Uint16 value within the valid range.
+   * Generates a random `Uint16` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random Uint16 between 0 and 65535.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Uint16` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a Uint16 to the power of another Uint16.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Uint16` (floored to
+   * an integer).
    *
-   * @param a The base Uint16.
-   * @param b The exponent Uint16.
-   * @returns `a ** b` clamped to [0, 65535] as a Uint16.
+   * @param a - The base non-negative integer
+   * @param b - The exponent non-negative integer
+   * @returns `a ** b` as an `Uint16`
    */
   pow,
 
   /**
-   * Adds two Uint16 values.
+   * Adds two non-negative integers, returning `a + b` as an `Uint16`.
    *
-   * @param a The first Uint16.
-   * @param b The second Uint16.
-   * @returns `a + b` clamped to [0, 65535] as a Uint16.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The sum of `a` and `b` as an `Uint16`
    */
   add,
 
   /**
-   * Subtracts one Uint16 from another.
+   * Subtracts two non-negative integers, returning `a - b` as an `Uint16`.
    *
-   * @param a The minuend Uint16.
-   * @param b The subtrahend Uint16.
-   * @returns `a - b` clamped to [0, 65535] as a Uint16 (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 `Uint16`
    */
   sub,
 
   /**
-   * Multiplies two Uint16 values.
+   * Multiplies two non-negative integers, returning `a * b` as an `Uint16`.
    *
-   * @param a The first Uint16.
-   * @param b The second Uint16.
-   * @returns `a * b` clamped to [0, 65535] as a Uint16.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The product of `a` and `b` as an `Uint16`
    */
   mul,
 
   /**
-   * Divides one Uint16 by another using floor division.
+   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as an `Uint16`.
    *
-   * @param a The dividend Uint16.
-   * @param b The divisor Uint16.
-   * @returns `⌊a / b⌋` clamped to [0, 65535] as a Uint16.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Uint16`
    */
   div,
 } as const;