ts-data-forge 11.0.0 → 12.0.0

package/src/number/branded-types/positive-int32.mts

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

package/src/number/branded-types/positive-safe-int.mts

@@ -16,8 +16,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -38,8 +38,10 @@ const {
 } as const);
 
 /**
- * Checks if a number is a PositiveSafeInt (a positive safe integer in the range
- * [1, MAX_SAFE_INTEGER]).
+ * Type guard that checks if a value is a positive safe integer.
+ *
+ * Returns `true` for a positive safe integer — a value with no fractional
+ * component.
  *
  * @example
  *
@@ -53,13 +55,16 @@ const {
  * assert.isTrue(PositiveSafeInt.is(42));
  * ```
  *
- * @param value The value to check.
- * @returns `true` if the value is a PositiveSafeInt, `false` otherwise.
+ * @param value - The value to check
+ * @returns `true` if the value is a positive safe integer, `false` otherwise
  */
 export const isPositiveSafeInt = is;
 
 /**
- * Casts a number to a PositiveSafeInt type.
+ * Casts a `number` to the `PositiveSafeInt` branded type.
+ *
+ * Validates that the value is a positive safe integer and returns it with the
+ * `PositiveSafeInt` brand. Throws a `TypeError` otherwise.
  *
  * @example
  *
@@ -71,24 +76,22 @@ export const isPositiveSafeInt = is;
  * assert.isTrue(PositiveSafeInt.is(branded));
  * ```
  *
- * @param value The value to cast.
- * @returns The value as a PositiveSafeInt type.
- * @throws {TypeError} If the value is not a positive safe integer.
+ * @param value - The value to cast
+ * @returns The value as a `PositiveSafeInt`
+ * @throws {TypeError} If the value is not a positive safe integer
  */
 export const asPositiveSafeInt = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for positive safe
- * integers.
+ * Namespace providing type-safe operations for the `PositiveSafeInt` branded
+ * type.
  *
- * All operations automatically clamp results to the positive safe integer range
- * [1, MAX_SAFE_INTEGER]. This ensures that all arithmetic maintains both the
- * positive constraint and IEEE 754 precision guarantees, preventing precision
- * loss and ensuring results are always positive.
+ * The `PositiveSafeInt` type represents a positive safe integer. Division
+ * (`div`) uses floor division.
  */
 export const PositiveSafeInt = {
   /**
-   * Type guard to check if a value is a PositiveSafeInt.
+   * Type guard that checks if a value is a positive safe integer.
    *
    * @example
    *
@@ -102,28 +105,26 @@ export const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(42));
    * ```
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a positive safe integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a positive safe integer, `false` otherwise
    * @see {@link isPositiveSafeInt} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a positive safe integer.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveSafeInt` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The maximum safe integer value (2^53 - 1).
-   *
-   * @readonly
+   * The largest value representable as `PositiveSafeInt` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
   /**
-   * Returns the smaller of two PositiveSafeInt values.
+   * Returns the smallest of the given positive safe integers.
    *
    * @example
    *
@@ -136,14 +137,13 @@ export const PositiveSafeInt = {
    * assert.isTrue(smallest === 5);
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns The minimum value as a PositiveSafeInt.
+   * @param values - The positive safe integers to compare (at least one required)
+   * @returns The smallest value as a `PositiveSafeInt`
    */
   min: min_,
 
   /**
-   * Returns the larger of two PositiveSafeInt values.
+   * Returns the largest of the given positive safe integers.
    *
    * @example
    *
@@ -156,23 +156,27 @@ export const PositiveSafeInt = {
    * assert.isTrue(largest === 10);
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns The maximum value as a PositiveSafeInt.
+   * @param values - The positive safe integers to compare (at least one required)
+   * @returns The largest value as a `PositiveSafeInt`
    */
   max: max_,
 
   /**
-   * Clamps a number to the positive safe integer range.
+   * Converts an arbitrary `number` into a `PositiveSafeInt`, rounding to the
+   * nearest integer and saturating the result into the range `[MIN_VALUE,
+   * MAX_VALUE]`.
+   *
+   * Unlike `asPositiveSafeInt`, this is total: out-of-range inputs are clamped
+   * to the nearest representable `PositiveSafeInt` instead of throwing.
    *
    * @example
    *
    * ```ts
-   * const belowRange = PositiveSafeInt.clamp(0);
+   * const belowRange = PositiveSafeInt.fromNumber(0);
    *
-   * const withinRange = PositiveSafeInt.clamp(123);
+   * const withinRange = PositiveSafeInt.fromNumber(123);
    *
-   * const aboveRange = PositiveSafeInt.clamp(Number.MAX_SAFE_INTEGER + 10);
+   * const aboveRange = PositiveSafeInt.fromNumber(Number.MAX_SAFE_INTEGER + 10);
    *
    * assert.isTrue(belowRange === 1);
    *
@@ -181,13 +185,15 @@ export const PositiveSafeInt = {
    * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
    * ```
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param value - The value to convert
+   * @returns The value as a `PositiveSafeInt`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * Generates a random PositiveSafeInt value within the valid range.
+   * Generates a random `PositiveSafeInt` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -203,12 +209,15 @@ export const PositiveSafeInt = {
    * assert.isTrue(randomValue >= 1 && randomValue <= 6);
    * ```
    *
-   * @returns A random PositiveSafeInt between 1 and MAX_SAFE_INTEGER.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveSafeInt` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a PositiveSafeInt to the power of another PositiveSafeInt.
+   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveSafeInt`
+   * (floored to an integer).
    *
    * @example
    *
@@ -222,14 +231,14 @@ export const PositiveSafeInt = {
    * assert.isTrue(power === 27);
    * ```
    *
-   * @param a The base PositiveSafeInt.
-   * @param b The exponent PositiveSafeInt.
-   * @returns `a ** b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The base positive safe integer
+   * @param b - The exponent positive safe integer
+   * @returns `a ** b` as a `PositiveSafeInt`
    */
   pow,
 
   /**
-   * Adds two PositiveSafeInt values.
+   * Adds two positive safe integers, returning `a + b` as a `PositiveSafeInt`.
    *
    * @example
    *
@@ -244,14 +253,15 @@ export const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(sum));
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns `a + b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The sum of `a` and `b` as a `PositiveSafeInt`
    */
   add,
 
   /**
-   * Subtracts one PositiveSafeInt from another.
+   * Subtracts two positive safe integers, returning `a - b` as a
+   * `PositiveSafeInt`.
    *
    * @example
    *
@@ -266,15 +276,15 @@ export const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(difference));
    * ```
    *
-   * @param a The minuend PositiveSafeInt.
-   * @param b The subtrahend PositiveSafeInt.
-   * @returns `a - b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt
-   *   (minimum 1).
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The difference of `a` and `b` as a `PositiveSafeInt`
    */
   sub,
 
   /**
-   * Multiplies two PositiveSafeInt values.
+   * Multiplies two positive safe integers, returning `a * b` as a
+   * `PositiveSafeInt`.
    *
    * @example
    *
@@ -289,14 +299,15 @@ export const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(product));
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns `a * b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The product of `a` and `b` as a `PositiveSafeInt`
    */
   mul,
 
   /**
-   * Divides one PositiveSafeInt by another using floor division.
+   * Divides two positive safe integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as a `PositiveSafeInt`.
    *
    * @example
    *
@@ -316,9 +327,9 @@ export const PositiveSafeInt = {
    * assert.isTrue(clamped === 1);
    * ```
    *
-   * @param a The dividend PositiveSafeInt.
-   * @param b The divisor PositiveSafeInt.
-   * @returns `⌊a / b⌋` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `PositiveSafeInt`
    */
   div,
 } as const;