ts-data-forge 11.0.0 → 12.0.0

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

@@ -13,7 +13,7 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -33,117 +33,122 @@ const {
 } as const);
 
 /**
- * Checks if a number is a NonZeroUint32 (32-bit non-zero unsigned integer in
- * the range [1, 2^32)).
+ * Type guard that checks if a value is a non-zero integer in [1, 2^32).
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroUint32, `false` otherwise.
+ * Returns `true` for a non-zero integer in [1, 2^32) — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise
  */
 export const isNonZeroUint32 = is;
 
 /**
- * Casts a number to a NonZeroUint32 type.
+ * Casts a `number` to the `NonZeroUint32` branded type.
+ *
+ * Validates that the value is a non-zero integer in [1, 2^32) and returns it
+ * with the `NonZeroUint32` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonZeroUint32 type.
- * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32).
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroUint32`
+ * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32)
  */
 export const asNonZeroUint32 = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for 32-bit non-zero
- * unsigned integers.
+ * Namespace providing type-safe operations for the `NonZeroUint32` branded
+ * type.
  *
- * All operations automatically clamp results to the valid NonZeroUint32 range
- * [1, 4294967295]. This ensures that all arithmetic maintains the 32-bit
- * non-zero unsigned integer constraint, with results below 1 clamped to
- * MIN_VALUE and overflow results clamped to MAX_VALUE.
+ * The `NonZeroUint32` type represents a non-zero integer in [1, 2^32). Division
+ * (`div`) uses floor division.
  */
 export const NonZeroUint32 = {
   /**
-   * Type guard to check if a value is a NonZeroUint32.
+   * Type guard that checks if a value is a non-zero integer in [1, 2^32).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 32-bit non-zero unsigned integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise
+   * @see {@link isNonZeroUint32} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a 32-bit non-zero unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `NonZeroUint32` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for a 32-bit non-zero unsigned integer.
-   *
-   * @readonly
+   * The largest value representable as `NonZeroUint32` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
   /**
-   * Returns the smaller of two NonZeroUint32 values.
+   * Returns the smallest of the given non-zero integers.
    *
-   * @param a The first NonZeroUint32.
-   * @param b The second NonZeroUint32.
-   * @returns The minimum value as a NonZeroUint32.
+   * @param values - The non-zero integers to compare (at least one required)
+   * @returns The smallest value as a `NonZeroUint32`
    */
   min: min_,
 
   /**
-   * Returns the larger of two NonZeroUint32 values.
+   * Returns the largest of the given non-zero integers.
    *
-   * @param a The first NonZeroUint32.
-   * @param b The second NonZeroUint32.
-   * @returns The maximum value as a NonZeroUint32.
+   * @param values - The non-zero integers to compare (at least one required)
+   * @returns The largest value as a `NonZeroUint32`
    */
   max: max_,
 
   /**
-   * Clamps a number to the NonZeroUint32 range.
+   * Converts an arbitrary `number` into a `NonZeroUint32`, rounding to the
+   * nearest integer and saturating the result into the range `[MIN_VALUE,
+   * MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [1, 4294967295] as a NonZeroUint32.
+   * Unlike `asNonZeroUint32`, this is total: out-of-range inputs are clamped to
+   * the nearest representable `NonZeroUint32` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NonZeroUint32`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * Generates a random NonZeroUint32 value within the valid range.
+   * Generates a random `NonZeroUint32` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random NonZeroUint32 between 1 and 4294967295.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonZeroUint32` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a NonZeroUint32 to the power of another NonZeroUint32.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint32`
+   * (floored to an integer).
    *
-   * @param a The base NonZeroUint32.
-   * @param b The exponent NonZeroUint32.
-   * @returns `a ** b` clamped to [1, 4294967295] as a NonZeroUint32.
+   * @param a - The base non-zero integer
+   * @param b - The exponent non-zero integer
+   * @returns `a ** b` as a `NonZeroUint32`
    */
   pow,
 
   /**
-   * Adds two NonZeroUint32 values.
+   * Adds two non-zero integers, returning `a + b` as a `NonZeroUint32`.
    *
-   * @param a The first NonZeroUint32.
-   * @param b The second NonZeroUint32.
-   * @returns `a + b` clamped to [1, 4294967295] as a NonZeroUint32.
+   * @param a - The first non-zero integer
+   * @param b - The second non-zero integer
+   * @returns The sum of `a` and `b` as a `NonZeroUint32`
    */
   add,
 
   /**
-   * Multiplies two NonZeroUint32 values.
-   *
-   * Both `add` and `mul` stay within `[1, 4294967295]`. For the non-closed
-   * operations (`sub`/`div`, whose result may be `0`) use {@link Num.sub} /
-   * {@link Num.divInt}.
+   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint32`.
    *
-   * @param a The first NonZeroUint32.
-   * @param b The second NonZeroUint32.
-   * @returns `a * b` clamped to [1, 4294967295] as a NonZeroUint32.
+   * @param a - The first non-zero integer
+   * @param b - The second non-zero integer
+   * @returns The product of `a` and `b` as a `NonZeroUint32`
    */
   mul,
 } as const;

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

@@ -16,8 +16,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -78,148 +78,166 @@ expectType<
 >('=');
 
 /**
- * Checks if a number is a PositiveFiniteNumber (a finite number > 0).
+ * Type guard that checks if a value is a positive finite number.
  *
- * @param value The value to check.
- * @returns `true` if the value is a PositiveFiniteNumber, `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 positive finite number, `false` otherwise
  */
 export const isPositiveFiniteNumber = is;
 
 /**
- * Casts a number to a PositiveFiniteNumber type.
+ * Casts a `number` to the `PositiveFiniteNumber` branded type.
+ *
+ * Validates that the value is a positive finite number and returns it with the
+ * `PositiveFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a PositiveFiniteNumber type.
- * @throws {TypeError} If the value is not a positive finite number.
+ * @param value - The value to cast
+ * @returns The value as a `PositiveFiniteNumber`
+ * @throws {TypeError} If the value is not a positive finite number
  */
 export const asPositiveFiniteNumber = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for positive finite
- * numbers.
+ * Namespace providing type-safe operations for the `PositiveFiniteNumber`
+ * branded type.
  *
- * All operations maintain the positive constraint by clamping non-positive
- * results to MIN_VALUE, while ensuring results remain finite (excluding NaN and
- * Infinity). This type is useful for representing quantities that must always
- * be positive, such as probabilities, magnitudes, and physical measurements.
+ * The `PositiveFiniteNumber` type represents a positive finite number.
  */
 export const PositiveFiniteNumber = {
   /**
-   * Type guard to check if a value is a PositiveFiniteNumber.
+   * Type guard that checks if a value is a positive finite number.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a positive finite number, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a positive finite number, `false` otherwise
+   * @see {@link isPositiveFiniteNumber} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a positive finite number.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveFiniteNumber` (the lower
+   * saturation target of `fromNumber`). The domain is open at `0` (excluded),
+   * so this is `Number.MIN_VALUE` — the smallest positive double — rather than
+   * `0`.
    */
   MIN_VALUE,
 
   /**
-   * Returns the smaller of two PositiveFiniteNumber values.
+   * Returns the smallest of the given positive finite numbers.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns The minimum value as a PositiveFiniteNumber.
+   * @param values - The positive finite numbers to compare (at least one required)
+   * @returns The smallest value as a `PositiveFiniteNumber`
    */
   min: min_,
 
   /**
-   * Returns the larger of two PositiveFiniteNumber values.
+   * Returns the largest of the given positive finite numbers.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns The maximum value as a PositiveFiniteNumber.
+   * @param values - The positive finite numbers to compare (at least one required)
+   * @returns The largest value as a `PositiveFiniteNumber`
    */
   max: max_,
 
   /**
-   * Clamps a number to the positive finite range.
+   * Converts an arbitrary `number` into a `PositiveFiniteNumber`, saturating it
+   * into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.
+   * Unlike `asPositiveFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `PositiveFiniteNumber` instead of
+   * throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `PositiveFiniteNumber`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * Rounds down a PositiveFiniteNumber to the nearest integer.
+   * Returns the greatest integer less than or equal to a positive finite
+   * number.
    *
-   * @param x The PositiveFiniteNumber to round down.
-   * @returns The floor value as a Uint (can be 0).
+   * @param a - The positive finite number value
+   * @returns The floored value as an integer
    */
   floor,
 
   /**
-   * Rounds up a PositiveFiniteNumber to the nearest integer.
+   * Returns the smallest integer greater than or equal to a positive finite
+   * number.
    *
-   * @param x The PositiveFiniteNumber to round up.
-   * @returns The ceiling value as a PositiveInt (always >= 1).
+   * @param a - The positive finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
 
   /**
-   * Rounds a PositiveFiniteNumber to the nearest integer.
+   * Returns the value of a positive finite number rounded to the nearest
+   * integer.
    *
-   * @param x The PositiveFiniteNumber to round.
-   * @returns The rounded value as a Uint (can be 0 if x < 0.5).
+   * @param a - The positive finite number value
+   * @returns The rounded value as an integer
    */
   round,
 
   /**
-   * Generates a random PositiveFiniteNumber value.
+   * Generates a random `PositiveFiniteNumber` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random positive finite number.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveFiniteNumber` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.
+   * Raises `a` to the power `b`, returning `a ** b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The base PositiveFiniteNumber.
-   * @param b The exponent PositiveFiniteNumber.
-   * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The base positive finite number
+   * @param b - The exponent positive finite number
+   * @returns `a ** b` as a `PositiveFiniteNumber`
    */
   pow,
 
   /**
-   * Adds two PositiveFiniteNumber values.
+   * Adds two positive finite numbers, returning `a + b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`
    */
   add,
 
   /**
-   * Subtracts one PositiveFiniteNumber from another.
+   * Subtracts two positive finite numbers, returning `a - b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The minuend PositiveFiniteNumber.
-   * @param b The subtrahend PositiveFiniteNumber.
-   * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum
-   *   MIN_VALUE).
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`
    */
   sub,
 
   /**
-   * Multiplies two PositiveFiniteNumber values.
+   * Multiplies two positive finite numbers, returning `a * b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The product of `a` and `b` as a `PositiveFiniteNumber`
    */
   mul,
 
   /**
-   * Divides one PositiveFiniteNumber by another.
+   * Divides two positive finite numbers, returning `a / b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The dividend PositiveFiniteNumber.
-   * @param b The divisor PositiveFiniteNumber.
-   * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns `a / b` as a `PositiveFiniteNumber`
    */
   div,
 } as const;