ts-data-forge 10.0.0 → 11.0.1

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

@@ -31,117 +31,118 @@ const {
 } as const);
 
 /**
- * Checks if a number is a NonPositiveSafeInt (non-positive safe integer in the
- * range [Number.MIN_SAFE_INTEGER, 0]).
+ * Type guard that checks if a value is a non-positive safe integer.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonPositiveSafeInt, `false` otherwise.
+ * Returns `true` for a non-positive safe integer — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-positive safe integer, `false` otherwise
  */
 export const isNonPositiveSafeInt = is;
 
 /**
- * Casts a number to a NonPositiveSafeInt type.
+ * Casts a `number` to the `NonPositiveSafeInt` branded type.
+ *
+ * Validates that the value is a non-positive safe integer and returns it with
+ * the `NonPositiveSafeInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonPositiveSafeInt type.
- * @throws {TypeError} If the value is not a non-positive safe integer.
+ * @param value - The value to cast
+ * @returns The value as a `NonPositiveSafeInt`
+ * @throws {TypeError} If the value is not a non-positive safe integer
  */
 export const asNonPositiveSafeInt = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for non-positive
- * safe integers.
+ * Namespace providing type-safe operations for the `NonPositiveSafeInt` branded
+ * type.
  *
- * All operations automatically clamp results to the valid NonPositiveSafeInt
- * range [Number.MIN_SAFE_INTEGER, 0]. This ensures that all arithmetic
- * maintains the non-positive safe integer constraint, with positive results
- * clamped to 0 and underflow results clamped to MIN_VALUE.
+ * The `NonPositiveSafeInt` type represents a non-positive safe integer.
+ * Division (`div`) uses floor division.
  */
 export const NonPositiveSafeInt = {
   /**
-   * Type guard to check if a value is a NonPositiveSafeInt.
+   * Type guard that checks if a value is a non-positive safe integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-positive safe integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-positive safe integer, `false` otherwise
+   * @see {@link isNonPositiveSafeInt} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a non-positive safe integer.
-   *
-   * @readonly
+   * The smallest value representable as `NonPositiveSafeInt`.
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for a non-positive safe integer.
-   *
-   * @readonly
+   * The largest value representable as `NonPositiveSafeInt`.
    */
   MAX_VALUE,
 
   /**
-   * Returns the smaller of two NonPositiveSafeInt values.
+   * Returns the smallest of the given non-positive safe integers.
    *
-   * @param a The first NonPositiveSafeInt.
-   * @param b The second NonPositiveSafeInt.
-   * @returns The minimum value as a NonPositiveSafeInt.
+   * @param values - The non-positive safe integers to compare (at least one required)
+   * @returns The smallest value as a `NonPositiveSafeInt`
    */
   min: min_,
 
   /**
-   * Returns the larger of two NonPositiveSafeInt values.
+   * Returns the largest of the given non-positive safe integers.
    *
-   * @param a The first NonPositiveSafeInt.
-   * @param b The second NonPositiveSafeInt.
-   * @returns The maximum value as a NonPositiveSafeInt.
+   * @param values - The non-positive safe integers to compare (at least one required)
+   * @returns The largest value as a `NonPositiveSafeInt`
    */
   max: max_,
 
   /**
-   * Clamps a number to the NonPositiveSafeInt range.
+   * Clamps a `number` into the `NonPositiveSafeInt` 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, 0] as a
-   *   NonPositiveSafeInt.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonPositiveSafeInt`
    */
   clamp,
 
   /**
-   * Generates a random NonPositiveSafeInt value within the valid range.
+   * Generates a random `NonPositiveSafeInt` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random NonPositiveSafeInt between Number.MIN_SAFE_INTEGER and 0.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonPositiveSafeInt` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a NonPositiveSafeInt to the power of another NonPositiveSafeInt.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveSafeInt`
+   * (floored to an integer).
    *
-   * @param a The base NonPositiveSafeInt.
-   * @param b The exponent NonPositiveSafeInt.
-   * @returns `a ** b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-   *   NonPositiveSafeInt.
+   * @param a - The base non-positive safe integer
+   * @param b - The exponent non-positive safe integer
+   * @returns `a ** b` as a `NonPositiveSafeInt`
    */
   pow,
 
   /**
-   * Adds two NonPositiveSafeInt values.
+   * Adds two non-positive safe integers, returning `a + b` as a
+   * `NonPositiveSafeInt`.
    *
-   * @param a The first NonPositiveSafeInt.
-   * @param b The second NonPositiveSafeInt.
-   * @returns `a + b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-   *   NonPositiveSafeInt.
+   * @param a - The first non-positive safe integer
+   * @param b - The second non-positive safe integer
+   * @returns The sum of `a` and `b` as a `NonPositiveSafeInt`
    */
   add,
 
   /**
-   * Subtracts one NonPositiveSafeInt from another.
+   * Subtracts two non-positive safe integers, returning `a - b` as a
+   * `NonPositiveSafeInt`.
    *
-   * @param a The minuend NonPositiveSafeInt.
-   * @param b The subtrahend NonPositiveSafeInt.
-   * @returns `a - b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-   *   NonPositiveSafeInt (maximum 0).
+   * @param a - The first non-positive safe integer
+   * @param b - The second non-positive safe integer
+   * @returns The difference of `a` and `b` as a `NonPositiveSafeInt`
    */
   sub,
 } as const;

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

@@ -34,8 +34,6 @@ const {
   typeNameInMessage,
 } as const);
 
-// Not provided because reasonable rounding operations that avoid becoming 0 cannot be defined
-
 const floor = (
   x: ElementType,
 ): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>
@@ -67,125 +65,138 @@ expectType<
 >('=');
 
 /**
- * Checks if a number is a NonZeroFiniteNumber (a finite number that is not 0).
+ * Type guard that checks if a value is a non-zero finite number.
+ *
+ * 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 NonZeroFiniteNumber, `false` otherwise.
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero finite number, `false` otherwise
  */
 export const isNonZeroFiniteNumber = is;
 
 /**
- * Casts a number to a NonZeroFiniteNumber type.
+ * Casts a `number` to the `NonZeroFiniteNumber` branded type.
+ *
+ * Validates that the value is a non-zero finite number and returns it with the
+ * `NonZeroFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonZeroFiniteNumber type.
- * @throws {TypeError} If the value is not a non-zero finite number.
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroFiniteNumber`
+ * @throws {TypeError} If the value is not a non-zero finite number
  */
 export const asNonZeroFiniteNumber = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for non-zero finite
- * numbers.
+ * Namespace providing type-safe operations for the `NonZeroFiniteNumber`
+ * branded type.
  *
- * All operations maintain the non-zero constraint while ensuring results remain
- * finite (excluding NaN and Infinity). This type is useful for values that must
- * never be zero, such as denominators, scaling factors, and ratios.
+ * The `NonZeroFiniteNumber` type represents a non-zero finite number.
  */
 export const NonZeroFiniteNumber = {
   /**
-   * Type guard to check if a value is a NonZeroFiniteNumber.
+   * Type guard that checks if a value is a non-zero finite number.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-zero finite number, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-zero finite number, `false` otherwise
+   * @see {@link isNonZeroFiniteNumber} for usage examples
    */
   is,
 
   /**
    * Returns the absolute value of a non-zero finite number.
    *
-   * @param a The NonZeroFiniteNumber.
-   * @returns The absolute value as a NonZeroFiniteNumber.
+   * The result is non-negative and keeps the `NonZeroFiniteNumber` brand.
+   *
+   * @param a - The non-zero finite number value
+   * @returns The absolute value as a non-negative `NonZeroFiniteNumber`
    */
   abs,
 
   /**
-   * Returns the smaller of two NonZeroFiniteNumber values.
+   * Returns the smallest of the given non-zero finite numbers.
    *
-   * @param a The first NonZeroFiniteNumber.
-   * @param b The second NonZeroFiniteNumber.
-   * @returns The minimum value as a NonZeroFiniteNumber.
+   * @param values - The non-zero finite numbers to compare (at least one required)
+   * @returns The smallest value as a `NonZeroFiniteNumber`
    */
   min: min_,
 
   /**
-   * Returns the larger of two NonZeroFiniteNumber values.
+   * Returns the largest of the given non-zero finite numbers.
    *
-   * @param a The first NonZeroFiniteNumber.
-   * @param b The second NonZeroFiniteNumber.
-   * @returns The maximum value as a NonZeroFiniteNumber.
+   * @param values - The non-zero finite numbers to compare (at least one required)
+   * @returns The largest value as a `NonZeroFiniteNumber`
    */
   max: max_,
 
   /**
-   * Rounds down a NonZeroFiniteNumber to the nearest integer.
+   * Returns the greatest integer less than or equal to a non-zero finite
+   * number.
    *
-   * @param x The NonZeroFiniteNumber to round down.
-   * @returns The floor value as a NonZeroInt.
+   * @param a - The non-zero finite number value
+   * @returns The floored value as an integer
    */
   floor,
 
   /**
-   * Rounds up a NonZeroFiniteNumber to the nearest integer.
+   * Returns the smallest integer greater than or equal to a non-zero finite
+   * number.
    *
-   * @param x The NonZeroFiniteNumber to round up.
-   * @returns The ceiling value as a NonZeroInt.
+   * @param a - The non-zero finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
 
   /**
-   * Rounds a NonZeroFiniteNumber to the nearest integer.
+   * Returns the value of a non-zero finite number rounded to the nearest
+   * integer.
    *
-   * @param x The NonZeroFiniteNumber to round.
-   * @returns The rounded value as a NonZeroInt.
+   * @param a - The non-zero finite number value
+   * @returns The rounded value as an integer
    */
   round,
 
   /**
-   * Generates a random NonZeroFiniteNumber value.
+   * Generates a random `NonZeroFiniteNumber` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random non-zero finite number.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonZeroFiniteNumber` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a NonZeroFiniteNumber to the power of another NonZeroFiniteNumber.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroFiniteNumber`.
    *
-   * @param a The base NonZeroFiniteNumber.
-   * @param b The exponent NonZeroFiniteNumber.
-   * @returns `a ** b` as a NonZeroFiniteNumber.
+   * @param a - The base non-zero finite number
+   * @param b - The exponent non-zero finite number
+   * @returns `a ** b` as a `NonZeroFiniteNumber`
    */
   pow,
 
   /**
-   * Multiplies two NonZeroFiniteNumber values.
+   * Multiplies two non-zero finite numbers, returning `a * b` as a
+   * `NonZeroFiniteNumber`.
    *
-   * @param a The first NonZeroFiniteNumber.
-   * @param b The second NonZeroFiniteNumber.
-   * @returns `a * b` as a NonZeroFiniteNumber.
+   * @param a - The first non-zero finite number
+   * @param b - The second non-zero finite number
+   * @returns The product of `a` and `b` as a `NonZeroFiniteNumber`
    */
   mul,
 
   /**
-   * Divides one NonZeroFiniteNumber by another.
+   * Divides two non-zero finite numbers, returning `a / b` as a
+   * `NonZeroFiniteNumber`.
    *
    * Exact (non-flooring) division of two non-zero finite numbers is always
    * non-zero, so this stays closed. For the non-closed operations (`add`/`sub`,
    * whose result may be `0`) use {@link Num.add}/{@link Num.sub}.
    *
-   * @param a The dividend NonZeroFiniteNumber.
-   * @param b The divisor NonZeroFiniteNumber.
-   * @returns `a / b` as a NonZeroFiniteNumber.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns `a / b` as a `NonZeroFiniteNumber`
    */
   div,
 } as const;

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

@@ -30,90 +30,103 @@ const {
 } as const);
 
 /**
- * Checks if a number is a NonZeroInt.
+ * Type guard that checks if a value is a non-zero integer.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroInt, `false` otherwise.
+ * Returns `true` for a non-zero integer — a value with no fractional component,
+ * including values outside the safe integer range (unlike `SafeInt`).
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero integer, `false` otherwise
  */
 export const isNonZeroInt = is;
 
 /**
- * Casts a number to a NonZeroInt type.
+ * Casts a `number` to the `NonZeroInt` branded type.
+ *
+ * Validates that the value is a non-zero integer and returns it with the
+ * `NonZeroInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonZeroInt type.
- * @throws {TypeError} If the value is not a non-zero integer.
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroInt`
+ * @throws {TypeError} If the value is not a non-zero integer
  */
 export const asNonZeroInt = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for non-zero integers.
+ * Namespace providing type-safe operations for the `NonZeroInt` branded type.
+ *
+ * The `NonZeroInt` type represents a non-zero integer. Division (`div`) uses
+ * floor division.
  *
- * All operations maintain the non-zero constraint, ensuring that results are
- * always valid NonZeroInt values. Division operations return floor division
- * results, and all arithmetic maintains integer precision.
+ * Unlike `SafeInt`, `NonZeroInt` allows values outside the safe integer range
+ * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's
+ * `number` type.
  */
 export const NonZeroInt = {
   /**
-   * Type guard to check if a value is a NonZeroInt.
+   * Type guard that checks if a value is a non-zero integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-zero integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-zero integer, `false` otherwise
+   * @see {@link isNonZeroInt} for usage examples
    */
   is,
 
   /**
    * Returns the absolute value of a non-zero integer.
    *
-   * @param a The non-zero integer.
-   * @returns The absolute value as a NonZeroInt.
+   * The result is non-negative and keeps the `NonZeroInt` brand. Note that
+   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
+   * use `SafeInt` for guaranteed precision.
+   *
+   * @param a - The non-zero integer value
+   * @returns The absolute value as a non-negative `NonZeroInt`
    */
   abs,
 
   /**
-   * Returns the smaller of two non-zero integers.
+   * Returns the smallest of the given non-zero integers.
    *
-   * @param a The first non-zero integer.
-   * @param b The second non-zero integer.
-   * @returns The minimum value as a NonZeroInt.
+   * @param values - The non-zero integers to compare (at least one required)
+   * @returns The smallest value as a `NonZeroInt`
    */
   min: min_,
 
   /**
-   * Returns the larger of two non-zero integers.
+   * Returns the largest of the given non-zero integers.
    *
-   * @param a The first non-zero integer.
-   * @param b The second non-zero integer.
-   * @returns The maximum value as a NonZeroInt.
+   * @param values - The non-zero integers to compare (at least one required)
+   * @returns The largest value as a `NonZeroInt`
    */
   max: max_,
 
   /**
-   * Generates a random non-zero integer.
+   * Generates a random `NonZeroInt` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random NonZeroInt value.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonZeroInt` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a non-zero integer to the power of another non-zero integer.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroInt` (floored
+   * to an integer).
    *
-   * @param a The base non-zero integer.
-   * @param b The exponent non-zero integer.
-   * @returns `a ** b` as a NonZeroInt.
+   * @param a - The base non-zero integer
+   * @param b - The exponent non-zero integer
+   * @returns `a ** b` as a `NonZeroInt`
    */
   pow,
 
   /**
-   * Multiplies two non-zero integers.
-   *
-   * The product of two non-zero integers is always non-zero, so this stays
-   * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
-   * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroInt`.
    *
-   * @param a The first non-zero integer.
-   * @param b The second non-zero integer.
-   * @returns `a * b` as a NonZeroInt.
+   * @param a - The first non-zero integer
+   * @param b - The second non-zero integer
+   * @returns The product of `a` and `b` as a `NonZeroInt`
    */
   mul,
 } as const;