ts-data-forge 11.0.0 → 12.0.0

package/src/number/branded-types/non-negative-int16.mts

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

package/src/number/branded-types/non-negative-int32.mts

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

package/src/number/branded-types/non-positive-finite-number.mts

@@ -11,7 +11,7 @@ const {
   MAX_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -63,129 +63,144 @@ const round = (
   >;
 
 /**
- * Checks if a number is a NonPositiveFiniteNumber (a finite number <= 0).
+ * Type guard that checks if a value is a non-positive finite number.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonPositiveFiniteNumber, `false` otherwise.
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-positive finite number, `false` otherwise
  */
 export const isNonPositiveFiniteNumber = is;
 
 /**
- * Casts a number to a NonPositiveFiniteNumber type.
+ * Casts a `number` to the `NonPositiveFiniteNumber` branded type.
+ *
+ * Validates that the value is a non-positive finite number and returns it with
+ * the `NonPositiveFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonPositiveFiniteNumber type.
- * @throws {TypeError} If the value is not a non-positive finite number.
+ * @param value - The value to cast
+ * @returns The value as a `NonPositiveFiniteNumber`
+ * @throws {TypeError} If the value is not a non-positive finite number
  */
 export const asNonPositiveFiniteNumber = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for non-positive finite
- * numbers.
+ * Namespace providing type-safe operations for the `NonPositiveFiniteNumber`
+ * branded type.
  *
- * All operations maintain the non-positive constraint by clamping positive
- * results to MAX_VALUE (0), while ensuring results remain finite (excluding NaN
- * and Infinity). This type is useful for representing quantities that must
- * always be non-positive, such as debts, penalties, and negative offsets.
+ * The `NonPositiveFiniteNumber` type represents a non-positive finite number.
  */
 export const NonPositiveFiniteNumber = {
   /**
-   * Type guard to check if a value is a NonPositiveFiniteNumber.
+   * Type guard that checks if a value is a non-positive finite number.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-positive finite number, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-positive finite number, `false` otherwise
+   * @see {@link isNonPositiveFiniteNumber} for usage examples
    */
   is,
 
   /**
-   * The maximum value for a non-positive finite number.
-   *
-   * @readonly
+   * The largest value representable as `NonPositiveFiniteNumber` (the upper
+   * saturation target of `fromNumber`).
    */
   MAX_VALUE,
 
   /**
-   * Returns the smaller of two NonPositiveFiniteNumber values.
+   * Returns the smallest of the given non-positive finite numbers.
    *
-   * @param a The first NonPositiveFiniteNumber.
-   * @param b The second NonPositiveFiniteNumber.
-   * @returns The minimum value as a NonPositiveFiniteNumber.
+   * @param values - The non-positive finite numbers to compare (at least one required)
+   * @returns The smallest value as a `NonPositiveFiniteNumber`
    */
   min: min_,
 
   /**
-   * Returns the larger of two NonPositiveFiniteNumber values.
+   * Returns the largest of the given non-positive finite numbers.
    *
-   * @param a The first NonPositiveFiniteNumber.
-   * @param b The second NonPositiveFiniteNumber.
-   * @returns The maximum value as a NonPositiveFiniteNumber.
+   * @param values - The non-positive finite numbers to compare (at least one required)
+   * @returns The largest value as a `NonPositiveFiniteNumber`
    */
   max: max_,
 
   /**
-   * Clamps a number to the non-positive finite range.
+   * Converts an arbitrary `number` into a `NonPositiveFiniteNumber`, saturating
+   * it into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+   * Unlike `asNonPositiveFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `NonPositiveFiniteNumber` instead of
+   * throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NonPositiveFiniteNumber`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * Rounds down a NonPositiveFiniteNumber to the nearest integer.
+   * Returns the greatest integer less than or equal to a non-positive finite
+   * number.
    *
-   * @param x The NonPositiveFiniteNumber to round down.
-   * @returns The floor value as a NonPositiveInt (can be 0).
+   * @param a - The non-positive finite number value
+   * @returns The floored value as an integer
    */
   floor,
 
   /**
-   * Rounds up a NonPositiveFiniteNumber to the nearest integer.
+   * Returns the smallest integer greater than or equal to a non-positive finite
+   * number.
    *
-   * @param x The NonPositiveFiniteNumber to round up.
-   * @returns The ceiling value as a NegativeInt (always <= -1) or 0.
+   * @param a - The non-positive finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
 
   /**
-   * Rounds a NonPositiveFiniteNumber to the nearest integer.
+   * Returns the value of a non-positive finite number rounded to the nearest
+   * integer.
    *
-   * @param x The NonPositiveFiniteNumber to round.
-   * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
+   * @param a - The non-positive finite number value
+   * @returns The rounded value as an integer
    */
   round,
 
   /**
-   * Generates a random NonPositiveFiniteNumber value.
+   * Generates a random `NonPositiveFiniteNumber` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random non-positive finite number.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonPositiveFiniteNumber` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a NonPositiveFiniteNumber to the power of another NonPositiveFiniteNumber.
+   * Raises `a` to the power `b`, returning `a ** b` as a
+   * `NonPositiveFiniteNumber`.
    *
-   * @param a The base NonPositiveFiniteNumber.
-   * @param b The exponent NonPositiveFiniteNumber.
-   * @returns `a ** b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+   * @param a - The base non-positive finite number
+   * @param b - The exponent non-positive finite number
+   * @returns `a ** b` as a `NonPositiveFiniteNumber`
    */
   pow,
 
   /**
-   * Adds two NonPositiveFiniteNumber values.
+   * Adds two non-positive finite numbers, returning `a + b` as a
+   * `NonPositiveFiniteNumber`.
    *
-   * @param a The first NonPositiveFiniteNumber.
-   * @param b The second NonPositiveFiniteNumber.
-   * @returns `a + b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+   * @param a - The first non-positive finite number
+   * @param b - The second non-positive finite number
+   * @returns The sum of `a` and `b` as a `NonPositiveFiniteNumber`
    */
   add,
 
   /**
-   * Subtracts one NonPositiveFiniteNumber from another.
+   * Subtracts two non-positive finite numbers, returning `a - b` as a
+   * `NonPositiveFiniteNumber`.
    *
-   * @param a The minuend NonPositiveFiniteNumber.
-   * @param b The subtrahend NonPositiveFiniteNumber.
-   * @returns `a - b` clamped to (-∞, 0] as a NonPositiveFiniteNumber (maximum 0).
+   * @param a - The first non-positive finite number
+   * @param b - The second non-positive finite number
+   * @returns The difference of `a` and `b` as a `NonPositiveFiniteNumber`
    */
   sub,
 } as const;