ts-data-forge 10.0.0 → 11.0.1

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

@@ -34,132 +34,138 @@ 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`.
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for a 32-bit non-negative integer.
-   *
-   * @readonly
+   * The largest value representable as `NonNegativeInt32`.
    */
   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.
+   * Clamps a `number` into the `NonNegativeInt32` 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, 2147483647] as a NonNegativeInt32.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonNegativeInt32`
    */
   clamp,
 
   /**
-   * 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

@@ -63,129 +63,139 @@ 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`.
    */
   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.
+   * Clamps a `number` into the `NonPositiveFiniteNumber` range `[MIN_VALUE,
+   * MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonPositiveFiniteNumber`
    */
   clamp,
 
   /**
-   * 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;

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

@@ -32,19 +32,9 @@ const {
 /**
  * Type guard that checks if a value is a non-positive integer.
  *
- * A non-positive integer is any integer less than or equal to zero (<= 0).
- * This includes zero and all negative integers, but excludes positive numbers
- * and non-integers.
- *
- * @example
- *
- * ```ts
- * assert.isTrue(isNonPositiveInt(0));
- *
- * assert.isTrue(isNonPositiveInt(-5));
- *
- * assert.isFalse(isNonPositiveInt(1));
- * ```
+ * Returns `true` for a non-positive 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-positive integer, `false` otherwise
@@ -52,200 +42,105 @@ const {
 export const isNonPositiveInt = is;
 
 /**
- * Casts a number to a NonPositiveInt branded type.
- *
- * This function validates that the input is a non-positive integer (<= 0) and
- * returns it with the NonPositiveInt brand. This ensures type safety for
- * operations that require non-positive integer values.
- *
- * @example
+ * Casts a `number` to the `NonPositiveInt` branded type.
  *
- * ```ts
- * const branded = asNonPositiveInt(-7);
- *
- * assert.isTrue(branded === -7);
- *
- * assert.isTrue(NonPositiveInt.is(branded));
- * ```
+ * Validates that the value is a non-positive integer and returns it with the
+ * `NonPositiveInt` brand. Throws a `TypeError` otherwise.
  *
  * @param value - The value to cast
- * @returns The value as a NonPositiveInt branded type
+ * @returns The value as a `NonPositiveInt`
  * @throws {TypeError} If the value is not a non-positive integer
  */
 export const asNonPositiveInt = castType;
 
 /**
- * Namespace providing type-safe operations for NonPositiveInt branded types.
- *
- * NonPositiveInt represents integers that are less than or equal to zero (<= 0).
- * All operations automatically clamp results to maintain the non-positive
- * constraint, ensuring that arithmetic operations never produce positive values.
+ * Namespace providing type-safe operations for the `NonPositiveInt` branded
+ * type.
  *
- * This type is essential for:
+ * The `NonPositiveInt` type represents a non-positive integer. Division (`div`)
+ * uses floor division.
  *
- * - Debts and negative balances
- * - Penalties and reductions
- * - Offsets and adjustments (downward)
- * - Negative counts or differences
- * - Depth or altitude below a reference point
+ * Unlike `SafeInt`, `NonPositiveInt` allows values outside the safe integer
+ * range (±2^53 − 1), so very large magnitudes may lose precision in
+ * JavaScript's `number` type.
  */
 export const NonPositiveInt = {
   /**
    * Type guard that checks if a value is a non-positive integer.
    *
-   * @example
-   *
-   * ```ts
-   * const value: number = -42;
-   *
-   * if (NonPositiveInt.is(value)) {
-   *   // value is now typed as NonPositiveInt
-   *   const debt = value;
-   * }
-   * ```
-   *
    * @param value - The value to check
    * @returns `true` if the value is a non-positive integer, `false` otherwise
+   * @see {@link isNonPositiveInt} for usage examples
    */
   is,
 
   /**
-   * The maximum value for a non-positive integer.
-   *
-   * @readonly
+   * The largest value representable as `NonPositiveInt`.
    */
   MAX_VALUE,
 
   /**
-   * Returns the smaller of two non-positive integers.
-   *
-   * Since non-positive integers range from negative infinity to 0, the smaller
-   * value is the one further from zero (more negative).
-   *
-   * @example
+   * Returns the smallest of the given non-positive integers.
    *
-   * ```ts
-   * const result = NonPositiveInt.min(-5, -10);
-   *
-   * assert.strictEqual(result, -10);
-   * ```
-   *
-   * @param a - The first non-positive integer
-   * @param b - The second non-positive integer
-   * @returns The minimum value as a non-positive integer
+   * @param values - The non-positive integers to compare (at least one required)
+   * @returns The smallest value as a `NonPositiveInt`
    */
   min: min_,
 
   /**
-   * Returns the larger of two non-positive integers.
-   *
-   * Since non-positive integers range from negative infinity to 0, the larger
-   * value is the one closer to zero (less negative).
-   *
-   * @example
-   *
-   * ```ts
-   * const result = NonPositiveInt.max(-5, -10);
-   *
-   * assert.strictEqual(result, -5);
-   * ```
+   * Returns the largest of the given non-positive integers.
    *
-   * @param a - The first non-positive integer
-   * @param b - The second non-positive integer
-   * @returns The maximum value as a non-positive integer
+   * @param values - The non-positive integers to compare (at least one required)
+   * @returns The largest value as a `NonPositiveInt`
    */
   max: max_,
 
   /**
-   * Clamps a number to the non-positive integer range.
-   *
-   * Any positive value is clamped to 0 (the maximum non-positive integer).
-   * Negative values are preserved as long as they are valid integers.
-   *
-   * @example
-   *
-   * ```ts
-   * assert.strictEqual(NonPositiveInt.clamp(5), 0);
-   *
-   * assert.strictEqual(NonPositiveInt.clamp(-5), -5);
+   * Clamps a `number` into the `NonPositiveInt` range, rounding to the nearest
+   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
-   * assert.strictEqual(NonPositiveInt.clamp(0), 0);
-   * ```
-   *
-   * @param value - The number to clamp
-   * @returns The value clamped to the non-positive integer range
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonPositiveInt`
    */
   clamp,
 
   /**
-   * Generates a random non-positive integer value.
-   *
-   * @example
-   *
-   * ```ts
-   * const randomValue = NonPositiveInt.random();
+   * Generates a random `NonPositiveInt` within the given range.
    *
-   * assert.isTrue(NonPositiveInt.is(randomValue));
-   * ```
+   * The range is inclusive on both ends.
    *
-   * @returns A random non-positive integer
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonPositiveInt` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a non-positive integer to the power of another non-positive integer.
-   *
-   * The result is clamped to the non-positive integer range.
-   *
-   * @example
-   *
-   * ```ts
-   * const result = NonPositiveInt.pow(-2, -1);
-   * ```
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveInt`
+   * (floored to an integer).
    *
    * @param a - The base non-positive integer
    * @param b - The exponent non-positive integer
-   * @returns `a ** b` clamped to the non-positive integer range
+   * @returns `a ** b` as a `NonPositiveInt`
    */
   pow,
 
   /**
-   * Adds two non-positive integers.
-   *
-   * The result is clamped to the non-positive integer range. If the sum is
-   * positive, it is clamped to 0.
-   *
-   * @example
-   *
-   * ```ts
-   * assert.strictEqual(NonPositiveInt.add(-5, -3), -8);
-   *
-   * assert.strictEqual(NonPositiveInt.add(-5, 10), 0);
-   * ```
+   * Adds two non-positive integers, returning `a + b` as a `NonPositiveInt`.
    *
    * @param a - The first non-positive integer
    * @param b - The second non-positive integer
-   * @returns `a + b` clamped to the non-positive integer range
+   * @returns The sum of `a` and `b` as a `NonPositiveInt`
    */
   add,
 
   /**
-   * Subtracts one non-positive integer from another.
-   *
-   * The result is clamped to the non-positive integer range. If the result is
-   * positive, it is clamped to 0.
+   * Subtracts two non-positive integers, returning `a - b` as a
+   * `NonPositiveInt`.
    *
-   * @example
-   *
-   * ```ts
-   * assert.strictEqual(NonPositiveInt.sub(-10, -3), -7);
-   *
-   * assert.strictEqual(NonPositiveInt.sub(-10, 5), 0);
-   * ```
-   *
-   * @param a - The minuend non-positive integer
-   * @param b - The subtrahend non-positive integer
-   * @returns `a - b` clamped to the non-positive integer range
+   * @param a - The first non-positive integer
+   * @param b - The second non-positive integer
+   * @returns The difference of `a` and `b` as a `NonPositiveInt`
    */
   sub,
 } as const;