ts-data-forge 10.0.0 → 11.0.1

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

@@ -35,139 +35,131 @@ const {
   typeNameInMessage,
 } as const);
 
-/**
- * Returns the absolute value of a negative safe integer.
- *
- * The absolute value of a negative safe integer is always a positive safe
- * integer (`>= 1`), so the result is typed as a {@link PositiveSafeInt}.
- *
- * @param x - The negative safe integer.
- * @returns `|x|` as a PositiveSafeInt.
- */
 const abs = (x: WithSmallInt<ElementType>): PositiveSafeInt =>
   PositiveSafeInt.clamp(Math.abs(x));
 
 /**
- * Checks if a number is a NegativeSafeInt (a negative safe integer in the range
- * `[Number.MIN_SAFE_INTEGER, -1]`).
+ * Type guard that checks if a value is a negative safe integer.
+ *
+ * Returns `true` for a negative safe integer — a value with no fractional
+ * component.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NegativeSafeInt, `false` otherwise.
+ * @param value - The value to check
+ * @returns `true` if the value is a negative safe integer, `false` otherwise
  */
 export const isNegativeSafeInt = is;
 
 /**
- * Casts a number to a NegativeSafeInt type.
+ * Casts a `number` to the `NegativeSafeInt` branded type.
+ *
+ * Validates that the value is a negative safe integer and returns it with the
+ * `NegativeSafeInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NegativeSafeInt type.
- * @throws {TypeError} If the value is not a negative safe integer.
+ * @param value - The value to cast
+ * @returns The value as a `NegativeSafeInt`
+ * @throws {TypeError} If the value is not a negative safe integer
  */
 export const asNegativeSafeInt = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for negative safe
- * integers.
+ * Namespace providing type-safe operations for the `NegativeSafeInt` branded
+ * type.
  *
- * NegativeSafeInt represents safe integers that are strictly less than zero
- * (`[Number.MIN_SAFE_INTEGER, -1]`). Operations that stay within the negative
- * safe integers clamp their results to the valid range, while operations whose
- * result leaves the set (`mul`, `div`, `abs`) are typed to reflect the actual
- * sign of the result.
+ * The `NegativeSafeInt` type represents a negative safe integer. Division
+ * (`div`) uses floor division.
  */
 export const NegativeSafeInt = {
   /**
-   * Type guard to check if a value is a NegativeSafeInt.
+   * Type guard that checks if a value is a negative safe integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a negative safe integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a negative safe integer, `false` otherwise
+   * @see {@link isNegativeSafeInt} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a negative safe integer.
-   *
-   * @readonly
+   * The smallest value representable as `NegativeSafeInt`.
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for a negative safe integer.
-   *
-   * @readonly
+   * The largest value representable as `NegativeSafeInt`.
    */
   MAX_VALUE,
 
   /**
    * Returns the absolute value of a negative safe integer.
    *
-   * @param a The negative safe integer.
-   * @returns The absolute value as a PositiveSafeInt.
+   * The result is non-negative and keeps the `NegativeSafeInt` brand.
+   *
+   * @param a - The negative safe integer value
+   * @returns The absolute value as a non-negative `NegativeSafeInt`
    */
   abs,
 
   /**
-   * Returns the smaller of two negative safe integers.
+   * Returns the smallest of the given negative safe integers.
    *
-   * @param a The first negative safe integer.
-   * @param b The second negative safe integer.
-   * @returns The minimum value as a NegativeSafeInt.
+   * @param values - The negative safe integers to compare (at least one required)
+   * @returns The smallest value as a `NegativeSafeInt`
    */
   min: min_,
 
   /**
-   * Returns the larger of two negative safe integers.
+   * Returns the largest of the given negative safe integers.
    *
-   * @param a The first negative safe integer.
-   * @param b The second negative safe integer.
-   * @returns The maximum value as a NegativeSafeInt.
+   * @param values - The negative safe integers to compare (at least one required)
+   * @returns The largest value as a `NegativeSafeInt`
    */
   max: max_,
 
   /**
-   * Clamps a number to the NegativeSafeInt range.
+   * Clamps a `number` into the `NegativeSafeInt` range, rounding to the nearest
+   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to `[Number.MIN_SAFE_INTEGER, -1]` as a
-   *   NegativeSafeInt.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NegativeSafeInt`
    */
   clamp,
 
   /**
-   * Generates a random NegativeSafeInt value within the valid range.
+   * Generates a random `NegativeSafeInt` within the given range.
    *
-   * @returns A random NegativeSafeInt between Number.MIN_SAFE_INTEGER and -1.
+   * The range is inclusive on both ends.
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NegativeSafeInt` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a negative safe integer to the power of another negative safe
-   * integer.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeSafeInt`
+   * (floored to an integer).
    *
-   * @param a The base negative safe integer.
-   * @param b The exponent negative safe integer.
-   * @returns `a ** b` clamped to the NegativeSafeInt range.
+   * @param a - The base negative safe integer
+   * @param b - The exponent negative safe integer
+   * @returns `a ** b` as a `NegativeSafeInt`
    */
   pow,
 
   /**
-   * Adds two negative safe integers.
+   * Adds two negative safe integers, returning `a + b` as a `NegativeSafeInt`.
    *
-   * @param a The first negative safe integer.
-   * @param b The second negative safe integer.
-   * @returns `a + b` clamped to the NegativeSafeInt range.
+   * @param a - The first negative safe integer
+   * @param b - The second negative safe integer
+   * @returns The sum of `a` and `b` as a `NegativeSafeInt`
    */
   add,
 
   /**
-   * Subtracts one negative safe integer from another.
-   *
-   * The mathematical result can be positive, so it is clamped to the
-   * NegativeSafeInt range (maximum `-1`).
+   * Subtracts two negative safe integers, returning `a - b` as a
+   * `NegativeSafeInt`.
    *
-   * @param a The minuend negative safe integer.
-   * @param b The subtrahend negative safe integer.
-   * @returns `a - b` clamped to the NegativeSafeInt range.
+   * @param a - The first negative safe integer
+   * @param b - The second negative safe integer
+   * @returns The difference of `a` and `b` as a `NegativeSafeInt`
    */
   sub,
 } as const;

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

@@ -57,149 +57,159 @@ expectType<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Uint>(
 );
 
 /**
- * Checks if a number is a NonNegativeFiniteNumber (a finite number >= 0).
+ * Type guard that checks if a value is a non-negative finite number.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonNegativeFiniteNumber, `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-negative finite number, `false` otherwise
  */
 export const isNonNegativeFiniteNumber = is;
 
 /**
- * Casts a number to a NonNegativeFiniteNumber type.
+ * Casts a `number` to the `NonNegativeFiniteNumber` branded type.
+ *
+ * Validates that the value is a non-negative finite number and returns it with
+ * the `NonNegativeFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonNegativeFiniteNumber type.
- * @throws {TypeError} If the value is not a non-negative finite number.
+ * @param value - The value to cast
+ * @returns The value as a `NonNegativeFiniteNumber`
+ * @throws {TypeError} If the value is not a non-negative finite number
  */
 export const asNonNegativeFiniteNumber = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for non-negative finite
- * numbers.
+ * Namespace providing type-safe operations for the `NonNegativeFiniteNumber`
+ * branded type.
  *
- * All operations maintain the non-negative constraint by clamping negative
- * results to 0, while ensuring results remain finite (excluding NaN and
- * Infinity). This type is useful for representing measurements, distances,
- * weights, and other inherently non-negative values.
+ * The `NonNegativeFiniteNumber` type represents a non-negative finite number.
  */
 export const NonNegativeFiniteNumber = {
   /**
-   * Type guard to check if a value is a NonNegativeFiniteNumber.
+   * Type guard that checks if a value is a non-negative finite number.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-negative finite number, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-negative finite number, `false` otherwise
+   * @see {@link isNonNegativeFiniteNumber} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a non-negative finite number.
-   *
-   * @readonly
+   * The smallest value representable as `NonNegativeFiniteNumber`.
    */
   MIN_VALUE,
 
   /**
-   * Returns the smaller of two NonNegativeFiniteNumber values.
+   * Returns the smallest of the given non-negative finite numbers.
    *
-   * @param a The first NonNegativeFiniteNumber.
-   * @param b The second NonNegativeFiniteNumber.
-   * @returns The minimum value as a NonNegativeFiniteNumber.
+   * @param values - The non-negative finite numbers to compare (at least one required)
+   * @returns The smallest value as a `NonNegativeFiniteNumber`
    */
   min: min_,
 
   /**
-   * Returns the larger of two NonNegativeFiniteNumber values.
+   * Returns the largest of the given non-negative finite numbers.
    *
-   * @param a The first NonNegativeFiniteNumber.
-   * @param b The second NonNegativeFiniteNumber.
-   * @returns The maximum value as a NonNegativeFiniteNumber.
+   * @param values - The non-negative finite numbers to compare (at least one required)
+   * @returns The largest value as a `NonNegativeFiniteNumber`
    */
   max: max_,
 
   /**
-   * Clamps a number to the non-negative finite range.
+   * Clamps a `number` into the `NonNegativeFiniteNumber` range `[MIN_VALUE,
+   * MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonNegativeFiniteNumber`
    */
   clamp,
 
   /**
-   * Rounds down a NonNegativeFiniteNumber to the nearest integer.
+   * Returns the greatest integer less than or equal to a non-negative finite
+   * number.
    *
-   * @param x The NonNegativeFiniteNumber to round down.
-   * @returns The floor value as a Uint.
+   * @param a - The non-negative finite number value
+   * @returns The floored value as an integer
    */
   floor,
 
   /**
-   * Rounds up a NonNegativeFiniteNumber to the nearest integer.
+   * Returns the smallest integer greater than or equal to a non-negative finite
+   * number.
    *
-   * @param x The NonNegativeFiniteNumber to round up.
-   * @returns The ceiling value as a Uint.
+   * @param a - The non-negative finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
 
   /**
-   * Rounds a NonNegativeFiniteNumber to the nearest integer.
+   * Returns the value of a non-negative finite number rounded to the nearest
+   * integer.
    *
-   * @param x The NonNegativeFiniteNumber to round.
-   * @returns The rounded value as a Uint.
+   * @param a - The non-negative finite number value
+   * @returns The rounded value as an integer
    */
   round,
 
   /**
-   * Generates a random NonNegativeFiniteNumber value.
+   * Generates a random `NonNegativeFiniteNumber` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random non-negative finite number.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonNegativeFiniteNumber` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a NonNegativeFiniteNumber to the power of another
-   * NonNegativeFiniteNumber.
+   * Raises `a` to the power `b`, returning `a ** b` as a
+   * `NonNegativeFiniteNumber`.
    *
-   * @param a The base NonNegativeFiniteNumber.
-   * @param b The exponent NonNegativeFiniteNumber.
-   * @returns `a ** b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   * @param a - The base non-negative finite number
+   * @param b - The exponent non-negative finite number
+   * @returns `a ** b` as a `NonNegativeFiniteNumber`
    */
   pow,
 
   /**
-   * Adds two NonNegativeFiniteNumber values.
+   * Adds two non-negative finite numbers, returning `a + b` as a
+   * `NonNegativeFiniteNumber`.
    *
-   * @param a The first NonNegativeFiniteNumber.
-   * @param b The second NonNegativeFiniteNumber.
-   * @returns `a + b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   * @param a - The first non-negative finite number
+   * @param b - The second non-negative finite number
+   * @returns The sum of `a` and `b` as a `NonNegativeFiniteNumber`
    */
   add,
 
   /**
-   * Subtracts one NonNegativeFiniteNumber from another.
+   * Subtracts two non-negative finite numbers, returning `a - b` as a
+   * `NonNegativeFiniteNumber`.
    *
-   * @param a The minuend NonNegativeFiniteNumber.
-   * @param b The subtrahend NonNegativeFiniteNumber.
-   * @returns `a - b` clamped to [0, +∞) as a NonNegativeFiniteNumber (minimum
-   *   0).
+   * @param a - The first non-negative finite number
+   * @param b - The second non-negative finite number
+   * @returns The difference of `a` and `b` as a `NonNegativeFiniteNumber`
    */
   sub,
 
   /**
-   * Multiplies two NonNegativeFiniteNumber values.
+   * Multiplies two non-negative finite numbers, returning `a * b` as a
+   * `NonNegativeFiniteNumber`.
    *
-   * @param a The first NonNegativeFiniteNumber.
-   * @param b The second NonNegativeFiniteNumber.
-   * @returns `a * b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   * @param a - The first non-negative finite number
+   * @param b - The second non-negative finite number
+   * @returns The product of `a` and `b` as a `NonNegativeFiniteNumber`
    */
   mul,
 
   /**
-   * Divides one NonNegativeFiniteNumber by another.
+   * Divides two non-negative finite numbers, returning `a / b` as a
+   * `NonNegativeFiniteNumber`.
    *
-   * @param a The dividend NonNegativeFiniteNumber.
-   * @param b The divisor NonNegativeFiniteNumber.
-   * @returns `a / b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns `a / b` as a `NonNegativeFiniteNumber`
    */
   div,
 } as const;

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

@@ -34,131 +34,138 @@ 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`.
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for a 16-bit non-negative integer.
-   *
-   * @readonly
+   * The largest value representable as `NonNegativeInt16`.
    */
   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.
+   * Clamps a `number` into the `NonNegativeInt16` range, rounding to the
+   * nearest integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, 32767] as a NonNegativeInt16.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonNegativeInt16`
    */
   clamp,
 
   /**
-   * 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;