ts-data-forge 10.0.0 → 11.0.1

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

@@ -59,47 +59,37 @@ expectType<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Int>(
 /**
  * Type guard that checks if a value is a finite number.
  *
- * Returns `true` if the value is a finite number (not NaN, Infinity, or
- * -Infinity). This is stricter than the standard number type, which includes
- * these special values.
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
  *
  * @param value - The value to check
- * @returns `true` if the value is finite, `false` otherwise
+ * @returns `true` if the value is a finite number, `false` otherwise
  */
 export const isFiniteNumber = is;
 
 /**
- * Casts a number to a FiniteNumber branded type.
+ * Casts a `number` to the `FiniteNumber` branded type.
  *
- * This function validates that the input is finite (not NaN, Infinity, or
- * -Infinity) and returns it with the FiniteNumber brand. This ensures type
- * safety for operations that require finite numeric values.
+ * Validates that the value is a finite number and returns it with the
+ * `FiniteNumber` brand. Throws a `TypeError` otherwise.
  *
  * @param value - The value to cast
- * @returns The value as a FiniteNumber branded type
- * @throws {TypeError} If the value is NaN, Infinity, or -Infinity
+ * @returns The value as a `FiniteNumber`
+ * @throws {TypeError} If the value is not a finite number
  */
 export const asFiniteNumber = castType;
 
 /**
- * Namespace providing type-safe operations for FiniteNumber branded types.
+ * Namespace providing type-safe operations for the `FiniteNumber` branded type.
  *
- * The FiniteNumber type represents any finite numeric value, excluding the
- * special values NaN, Infinity, and -Infinity. All operations are guaranteed to
- * maintain the finite constraint when given finite inputs.
- *
- * This type is essential for:
- *
- * - Mathematical operations that require real numbers
- * - Preventing NaN/Infinity propagation in calculations
- * - Ensuring numeric stability in algorithms
+ * The `FiniteNumber` type represents a finite number.
  */
 export const FiniteNumber = {
   /**
    * Type guard that checks if a value is a finite number.
    *
    * @param value - The value to check
-   * @returns `true` if the value is finite, `false` otherwise
+   * @returns `true` if the value is a finite number, `false` otherwise
    * @see {@link isFiniteNumber} for usage examples
    */
   is,
@@ -107,110 +97,106 @@ export const FiniteNumber = {
   /**
    * Returns the absolute value of a finite number.
    *
-   * @param x - The finite number to get the absolute value of
-   * @returns The absolute value as a FiniteNumber
+   * The result is non-negative and keeps the `FiniteNumber` brand.
+   *
+   * @param a - The finite number value
+   * @returns The absolute value as a non-negative `FiniteNumber`
    */
   abs,
 
   /**
-   * Returns the minimum value from a list of finite numbers.
+   * Returns the smallest of the given finite numbers.
    *
    * @param values - The finite numbers to compare (at least one required)
-   * @returns The smallest value as a FiniteNumber
+   * @returns The smallest value as a `FiniteNumber`
    */
   min: min_,
 
   /**
-   * Returns the maximum value from a list of finite numbers.
+   * Returns the largest of the given finite numbers.
    *
    * @param values - The finite numbers to compare (at least one required)
-   * @returns The largest value as a FiniteNumber
+   * @returns The largest value as a `FiniteNumber`
    */
   max: max_,
 
   /**
-   * Returns the largest integer less than or equal to the given finite number.
+   * Returns the greatest integer less than or equal to a finite number.
    *
-   * @param x - The finite number to floor
-   * @returns The floor value as an Int
+   * @param a - The finite number value
+   * @returns The floored value as an integer
    */
   floor,
 
   /**
-   * Returns the smallest integer greater than or equal to the given finite
-   * number.
+   * Returns the smallest integer greater than or equal to a finite number.
    *
-   * @param x - The finite number to ceil
-   * @returns The ceiling value as an Int
+   * @param a - The finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
 
   /**
-   * Rounds a finite number to the nearest integer.
+   * Returns the value of a finite number rounded to the nearest integer.
    *
-   * @param x - The finite number to round
-   * @returns The rounded value as an Int
+   * @param a - The finite number value
+   * @returns The rounded value as an integer
    */
   round,
 
   /**
-   * Generates a random finite number within the specified range.
+   * Generates a random `FiniteNumber` within the given range.
    *
-   * The generated value is uniformly distributed in the range [min, max]. Both
-   * bounds are inclusive.
+   * The range is inclusive on both ends.
    *
    * @param min - The minimum value (inclusive)
    * @param max - The maximum value (inclusive)
-   * @returns A random FiniteNumber in the range [min, max]
+   * @returns A random `FiniteNumber` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a finite number to a power.
+   * Raises `a` to the power `b`, returning `a ** b` as a `FiniteNumber`.
    *
    * @param a - The base finite number
    * @param b - The exponent finite number
-   * @returns `a ** b` as a FiniteNumber
+   * @returns `a ** b` as a `FiniteNumber`
    */
   pow,
 
   /**
-   * Adds two finite numbers.
+   * Adds two finite numbers, returning `a + b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a + b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The sum of `a` and `b` as a `FiniteNumber`
    */
   add,
 
   /**
-   * Subtracts two finite numbers.
+   * Subtracts two finite numbers, returning `a - b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a - b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The difference of `a` and `b` as a `FiniteNumber`
    */
   sub,
 
   /**
-   * Multiplies two finite numbers.
+   * Multiplies two finite numbers, returning `a * b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a * b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The product of `a` and `b` as a `FiniteNumber`
    */
   mul,
 
   /**
-   * Divides two finite numbers.
-   *
-   * The divisor must be non-zero (enforced by type constraints). The result is
-   * guaranteed to be finite when both inputs are finite and the divisor is
-   * non-zero.
+   * Divides two finite numbers, returning `a / b` as a `FiniteNumber`.
    *
    * @param a - The dividend
    * @param b - The divisor (must be non-zero)
-   * @returns The quotient `a / b` as a FiniteNumber
+   * @returns `a / b` as a `FiniteNumber`
    */
   div,
 } as const;

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

@@ -34,9 +34,8 @@ const {
 /**
  * Type guard that checks if a value is an integer.
  *
- * Returns `true` if the value is any integer (positive, negative, or zero),
- * with no fractional component. This includes values outside the safe integer
- * range, unlike SafeInt.
+ * Returns `true` for an integer — a value with no fractional component,
+ * including values outside the safe integer range (unlike `SafeInt`).
  *
  * @example
  *
@@ -54,11 +53,10 @@ const {
 export const isInt = is;
 
 /**
- * Casts a number to an Int branded type.
+ * Casts a `number` to the `Int` branded type.
  *
- * This function validates that the input is an integer and returns it with the
- * Int brand. Throws a TypeError if the value has a fractional component or is
- * not a finite number.
+ * Validates that the value is an integer and returns it with the `Int` brand.
+ * Throws a `TypeError` otherwise.
  *
  * @example
  *
@@ -71,21 +69,19 @@ export const isInt = is;
  * ```
  *
  * @param value - The value to cast
- * @returns The value as an Int branded type
+ * @returns The value as an `Int`
  * @throws {TypeError} If the value is not an integer
  */
 export const asInt = castType;
 
 /**
- * Namespace providing type-safe operations for Int branded types.
+ * Namespace providing type-safe operations for the `Int` branded type.
  *
- * The Int type represents any integer value (no fractional component) without
- * range restrictions. All operations preserve the integer constraint, using
- * floor division for division operations.
+ * The `Int` type represents an integer. Division (`div`) uses floor division.
  *
- * Unlike SafeInt, Int allows values outside the safe integer range (±2^53 - 1),
- * but be aware that very large integers may lose precision in JavaScript's
- * number type.
+ * Unlike `SafeInt`, `Int` allows values outside the safe integer range (±2^53 −
+ * 1), so very large magnitudes may lose precision in JavaScript's `number`
+ * type.
  */
 export const Int = {
   /**
@@ -110,9 +106,9 @@ export const Int = {
   /**
    * Returns the absolute value of an integer.
    *
-   * The result is always non-negative and maintains the Int brand. Note that
-   * Math.abs(Number.MIN_SAFE_INTEGER) exceeds Number.MAX_SAFE_INTEGER, so use
-   * SafeInt for guaranteed precision.
+   * The result is non-negative and keeps the `Int` brand. Note that
+   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
+   * use `SafeInt` for guaranteed precision.
    *
    * @example
    *
@@ -127,12 +123,12 @@ export const Int = {
    * ```
    *
    * @param a - The integer value
-   * @returns The absolute value as a non-negative Int
+   * @returns The absolute value as a non-negative `Int`
    */
   abs,
 
   /**
-   * Returns the minimum value from a list of integers.
+   * Returns the smallest of the given integers.
    *
    * @example
    *
@@ -143,12 +139,12 @@ export const Int = {
    * ```
    *
    * @param values - The integers to compare (at least one required)
-   * @returns The smallest value as an Int
+   * @returns The smallest value as an `Int`
    */
   min: min_,
 
   /**
-   * Returns the maximum value from a list of integers.
+   * Returns the largest of the given integers.
    *
    * @example
    *
@@ -159,15 +155,14 @@ export const Int = {
    * ```
    *
    * @param values - The integers to compare (at least one required)
-   * @returns The largest value as an Int
+   * @returns The largest value as an `Int`
    */
   max: max_,
 
   /**
-   * Generates a random integer within the specified range (inclusive).
+   * Generates a random `Int` within the given range.
    *
-   * The range is inclusive on both ends, so random(1, 6) can return any of: 1,
-   * 2, 3, 4, 5, or 6.
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -185,12 +180,13 @@ export const Int = {
    *
    * @param min - The minimum value (inclusive)
    * @param max - The maximum value (inclusive)
-   * @returns A random Int in the range [min, max]
+   * @returns A random `Int` in `[min, max]`
    */
   random,
 
   /**
-   * Raises an integer to a power.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Int` (floored to an
+   * integer).
    *
    * @example
    *
@@ -206,12 +202,12 @@ export const Int = {
    *
    * @param a - The base integer
    * @param b - The exponent integer
-   * @returns `a ** b` as an Int
+   * @returns `a ** b` as an `Int`
    */
   pow,
 
   /**
-   * Adds two integers.
+   * Adds two integers, returning `a + b` as an `Int`.
    *
    * @example
    *
@@ -221,14 +217,14 @@ export const Int = {
    * assert.isTrue(sum === 20);
    * ```
    *
-   * @param a - First integer
-   * @param b - Second integer
-   * @returns `a + b` as an Int
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The sum of `a` and `b` as an `Int`
    */
   add,
 
   /**
-   * Subtracts two integers.
+   * Subtracts two integers, returning `a - b` as an `Int`.
    *
    * @example
    *
@@ -238,14 +234,14 @@ export const Int = {
    * assert.isTrue(difference === 4);
    * ```
    *
-   * @param a - First integer
-   * @param b - Second integer
-   * @returns `a - b` as an Int
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The difference of `a` and `b` as an `Int`
    */
   sub,
 
   /**
-   * Multiplies two integers.
+   * Multiplies two integers, returning `a * b` as an `Int`.
    *
    * @example
    *
@@ -255,17 +251,15 @@ export const Int = {
    * assert.isTrue(product === -24);
    * ```
    *
-   * @param a - First integer
-   * @param b - Second integer
-   * @returns `a * b` as an Int
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The product of `a` and `b` as an `Int`
    */
   mul,
 
   /**
-   * Divides two integers using floor division.
-   *
-   * Performs mathematical floor division: `⌊a / b⌋`. The result is always an
-   * integer, rounding toward negative infinity.
+   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+   * b` rounded toward negative infinity, as an `Int`.
    *
    * @example
    *
@@ -281,7 +275,7 @@ export const Int = {
    *
    * @param a - The dividend
    * @param b - The divisor (must be non-zero)
-   * @returns The integer quotient as an Int
+   * @returns The floored quotient as an `Int`
    */
   div,
 } as const;

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

@@ -35,137 +35,144 @@ const {
 } as const);
 
 /**
- * Checks if a number is an Int16 (16-bit signed integer in the range [-2^15,
- * 2^15)).
+ * Type guard that checks if a value is an integer in [-2^15, 2^15).
  *
- * @param value The value to check.
- * @returns `true` if the value is an Int16, `false` otherwise.
+ * Returns `true` for an integer in [-2^15, 2^15) — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is an integer in [-2^15, 2^15), `false` otherwise
  */
 export const isInt16 = is;
 
 /**
- * Casts a number to an Int16 type.
+ * Casts a `number` to the `Int16` branded type.
+ *
+ * Validates that the value is an integer in [-2^15, 2^15) and returns it with
+ * the `Int16` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as an Int16 type.
- * @throws {TypeError} If the value is not an integer in [-2^15, 2^15).
+ * @param value - The value to cast
+ * @returns The value as an `Int16`
+ * @throws {TypeError} If the value is not an integer in [-2^15, 2^15)
  */
 export const asInt16 = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for 16-bit signed
- * integers.
+ * Namespace providing type-safe operations for the `Int16` branded type.
  *
- * All operations automatically clamp results to the valid Int16 range [-32768,
- * 32767]. This ensures that all arithmetic maintains the 16-bit signed integer
- * constraint.
+ * The `Int16` type represents an integer in [-2^15, 2^15). Division (`div`)
+ * uses floor division.
  */
 export const Int16 = {
   /**
-   * Type guard to check if a value is an Int16.
+   * Type guard that checks if a value is an integer in [-2^15, 2^15).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 16-bit signed integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is an integer in [-2^15, 2^15), `false` otherwise
+   * @see {@link isInt16} for usage examples
    */
   is,
 
   /**
-   * The minimum value for a 16-bit signed integer.
-   *
-   * @readonly
+   * The smallest value representable as `Int16`.
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for a 16-bit signed integer.
-   *
-   * @readonly
+   * The largest value representable as `Int16`.
    */
   MAX_VALUE,
 
   /**
-   * Returns the absolute value of a 16-bit signed integer.
+   * Returns the absolute value of an integer in [-2^15, 2^15).
+   *
+   * The result is non-negative and keeps the `Int16` brand.
    *
-   * @param a The Int16 value.
-   * @returns The absolute value as an Int16, clamped to valid range.
+   * @param a - The integer value
+   * @returns The absolute value as a non-negative `Int16`
    */
   abs,
 
   /**
-   * Returns the smaller of two Int16 values.
+   * Returns the smallest of the given integers.
    *
-   * @param a The first Int16.
-   * @param b The second Int16.
-   * @returns The minimum value as an Int16.
+   * @param values - The integers to compare (at least one required)
+   * @returns The smallest value as an `Int16`
    */
   min: min_,
 
   /**
-   * Returns the larger of two Int16 values.
+   * Returns the largest of the given integers.
    *
-   * @param a The first Int16.
-   * @param b The second Int16.
-   * @returns The maximum value as an Int16.
+   * @param values - The integers to compare (at least one required)
+   * @returns The largest value as an `Int16`
    */
   max: max_,
 
   /**
-   * Clamps a number to the Int16 range.
+   * Clamps a `number` into the `Int16` 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 [-32768, 32767] as an Int16.
+   * @param value - The value to clamp
+   * @returns The clamped value as an `Int16`
    */
   clamp,
 
   /**
-   * Generates a random Int16 value within the valid range.
+   * Generates a random `Int16` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random Int16 between MIN_VALUE and MAX_VALUE.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Int16` in `[min, max]`
    */
   random,
 
   /**
-   * Raises an Int16 to the power of another Int16.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Int16` (floored to
+   * an integer).
    *
-   * @param a The base Int16.
-   * @param b The exponent Int16.
-   * @returns `a ** b` clamped to [-32768, 32767] as an Int16.
+   * @param a - The base integer
+   * @param b - The exponent integer
+   * @returns `a ** b` as an `Int16`
    */
   pow,
 
   /**
-   * Adds two Int16 values.
+   * Adds two integers, returning `a + b` as an `Int16`.
    *
-   * @param a The first Int16.
-   * @param b The second Int16.
-   * @returns `a + b` clamped to [-32768, 32767] as an Int16.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The sum of `a` and `b` as an `Int16`
    */
   add,
 
   /**
-   * Subtracts one Int16 from another.
+   * Subtracts two integers, returning `a - b` as an `Int16`.
    *
-   * @param a The minuend Int16.
-   * @param b The subtrahend Int16.
-   * @returns `a - b` clamped to [-32768, 32767] as an Int16.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The difference of `a` and `b` as an `Int16`
    */
   sub,
 
   /**
-   * Multiplies two Int16 values.
+   * Multiplies two integers, returning `a * b` as an `Int16`.
    *
-   * @param a The first Int16.
-   * @param b The second Int16.
-   * @returns `a * b` clamped to [-32768, 32767] as an Int16.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The product of `a` and `b` as an `Int16`
    */
   mul,
 
   /**
-   * Divides one Int16 by another using floor division.
+   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+   * b` rounded toward negative infinity, as an `Int16`.
    *
-   * @param a The dividend Int16.
-   * @param b The divisor Int16.
-   * @returns `⌊a / b⌋` clamped to [-32768, 32767] as an Int16.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Int16`
    */
   div,
 } as const;