ts-data-forge 11.0.0 → 11.0.1

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

@@ -30,15 +30,6 @@ const {
   typeNameInMessage,
 } as const);
 
-/**
- * Returns the absolute value of a negative finite number.
- *
- * The absolute value of a negative finite number is always a positive finite
- * number, so the result is typed as a {@link PositiveFiniteNumber}.
- *
- * @param x - The negative finite number.
- * @returns `|x|` as a PositiveFiniteNumber.
- */
 const abs = (x: ElementType): PositiveFiniteNumber =>
   PositiveFiniteNumber.clamp(Math.abs(x));
 
@@ -71,140 +62,149 @@ const round = (
   >;
 
 /**
- * Checks if a number is a NegativeFiniteNumber (a finite number `< 0`).
+ * Type guard that checks if a value is a negative 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 NegativeFiniteNumber, `false` otherwise.
+ * @param value - The value to check
+ * @returns `true` if the value is a negative finite number, `false` otherwise
  */
 export const isNegativeFiniteNumber = is;
 
 /**
- * Casts a number to a NegativeFiniteNumber type.
+ * Casts a `number` to the `NegativeFiniteNumber` branded type.
  *
- * @param value The value to cast.
- * @returns The value as a NegativeFiniteNumber type.
- * @throws {TypeError} If the value is not a negative finite number.
+ * Validates that the value is a negative finite number and returns it with the
+ * `NegativeFiniteNumber` brand. Throws a `TypeError` otherwise.
+ *
+ * @param value - The value to cast
+ * @returns The value as a `NegativeFiniteNumber`
+ * @throws {TypeError} If the value is not a negative finite number
  */
 export const asNegativeFiniteNumber = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for negative finite
- * numbers.
+ * Namespace providing type-safe operations for the `NegativeFiniteNumber`
+ * branded type.
  *
- * All operations keep results finite (excluding NaN and Infinity). Operations
- * that stay within the negative finite numbers 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 `NegativeFiniteNumber` type represents a negative finite number.
  */
 export const NegativeFiniteNumber = {
   /**
-   * Type guard to check if a value is a NegativeFiniteNumber.
+   * Type guard that checks if a value is a negative finite number.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a negative finite number, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a negative finite number, `false` otherwise
+   * @see {@link isNegativeFiniteNumber} for usage examples
    */
   is,
 
   /**
-   * The maximum value for a negative finite number.
-   *
-   * @readonly
+   * The largest value representable as `NegativeFiniteNumber`.
    */
   MAX_VALUE,
 
   /**
    * Returns the absolute value of a negative finite number.
    *
-   * @param a The negative finite number.
-   * @returns The absolute value as a PositiveFiniteNumber.
+   * The result is non-negative and keeps the `NegativeFiniteNumber` brand.
+   *
+   * @param a - The negative finite number value
+   * @returns The absolute value as a non-negative `NegativeFiniteNumber`
    */
   abs,
 
   /**
-   * Returns the smaller of two NegativeFiniteNumber values.
+   * Returns the smallest of the given negative finite numbers.
    *
-   * @param a The first NegativeFiniteNumber.
-   * @param b The second NegativeFiniteNumber.
-   * @returns The minimum value as a NegativeFiniteNumber.
+   * @param values - The negative finite numbers to compare (at least one required)
+   * @returns The smallest value as a `NegativeFiniteNumber`
    */
   min: min_,
 
   /**
-   * Returns the larger of two NegativeFiniteNumber values.
+   * Returns the largest of the given negative finite numbers.
    *
-   * @param a The first NegativeFiniteNumber.
-   * @param b The second NegativeFiniteNumber.
-   * @returns The maximum value as a NegativeFiniteNumber.
+   * @param values - The negative finite numbers to compare (at least one required)
+   * @returns The largest value as a `NegativeFiniteNumber`
    */
   max: max_,
 
   /**
-   * Clamps a number to the negative finite range.
+   * Clamps a `number` into the `NegativeFiniteNumber` range `[MIN_VALUE,
+   * MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NegativeFiniteNumber`
    */
   clamp,
 
   /**
-   * Rounds down a NegativeFiniteNumber to the nearest integer.
+   * Returns the greatest integer less than or equal to a negative finite
+   * number.
    *
-   * @param x The NegativeFiniteNumber to round down.
-   * @returns The floor value as a NegativeInt (always `<= -1`).
+   * @param a - The negative finite number value
+   * @returns The floored value as an integer
    */
   floor,
 
   /**
-   * Rounds up a NegativeFiniteNumber to the nearest integer.
+   * Returns the smallest integer greater than or equal to a negative finite
+   * number.
    *
-   * @param x The NegativeFiniteNumber to round up.
-   * @returns The ceiling value as a NonPositiveInt (can be 0).
+   * @param a - The negative finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
 
   /**
-   * Rounds a NegativeFiniteNumber to the nearest integer.
+   * Returns the value of a negative finite number rounded to the nearest
+   * integer.
    *
-   * @param x The NegativeFiniteNumber to round.
-   * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
+   * @param a - The negative finite number value
+   * @returns The rounded value as an integer
    */
   round,
 
   /**
-   * Generates a random NegativeFiniteNumber value.
+   * Generates a random `NegativeFiniteNumber` within the given range.
    *
-   * @returns A random negative finite number.
+   * The range is inclusive on both ends.
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NegativeFiniteNumber` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a NegativeFiniteNumber to the power of another NegativeFiniteNumber.
+   * Raises `a` to the power `b`, returning `a ** b` as a
+   * `NegativeFiniteNumber`.
    *
-   * @param a The base NegativeFiniteNumber.
-   * @param b The exponent NegativeFiniteNumber.
-   * @returns `a ** b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   * @param a - The base negative finite number
+   * @param b - The exponent negative finite number
+   * @returns `a ** b` as a `NegativeFiniteNumber`
    */
   pow,
 
   /**
-   * Adds two NegativeFiniteNumber values.
+   * Adds two negative finite numbers, returning `a + b` as a
+   * `NegativeFiniteNumber`.
    *
-   * @param a The first NegativeFiniteNumber.
-   * @param b The second NegativeFiniteNumber.
-   * @returns `a + b` as a NegativeFiniteNumber.
+   * @param a - The first negative finite number
+   * @param b - The second negative finite number
+   * @returns The sum of `a` and `b` as a `NegativeFiniteNumber`
    */
   add,
 
   /**
-   * Subtracts one NegativeFiniteNumber from another.
-   *
-   * The mathematical result can be positive, so it is clamped to the negative
-   * finite range (maximum `-Number.MIN_VALUE`).
+   * Subtracts two negative finite numbers, returning `a - b` as a
+   * `NegativeFiniteNumber`.
    *
-   * @param a The minuend NegativeFiniteNumber.
-   * @param b The subtrahend NegativeFiniteNumber.
-   * @returns `a - b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   * @param a - The first negative finite number
+   * @param b - The second negative finite number
+   * @returns The difference of `a` and `b` as a `NegativeFiniteNumber`
    */
   sub,
 } as const;

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

@@ -34,127 +34,130 @@ const {
   typeNameInMessage,
 } as const);
 
-/**
- * Returns the absolute value of a negative integer.
- *
- * The absolute value of a negative integer is always a positive integer
- * (`>= 1`), so the result is typed as a {@link PositiveInt}.
- *
- * @param x - The negative integer.
- * @returns `|x|` as a PositiveInt.
- */
 const abs = (x: WithSmallInt<ElementType>): PositiveInt =>
   PositiveInt.clamp(Math.abs(x));
 
 /**
- * Checks if a number is a NegativeInt (a negative integer `<= -1`).
+ * Type guard that checks if a value is a negative integer.
+ *
+ * Returns `true` for a negative 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 NegativeInt, `false` otherwise.
+ * @param value - The value to check
+ * @returns `true` if the value is a negative integer, `false` otherwise
  */
 export const isNegativeInt = is;
 
 /**
- * Casts a number to a NegativeInt type.
+ * Casts a `number` to the `NegativeInt` branded type.
+ *
+ * Validates that the value is a negative integer and returns it with the
+ * `NegativeInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NegativeInt type.
- * @throws {TypeError} If the value is not a negative integer.
+ * @param value - The value to cast
+ * @returns The value as a `NegativeInt`
+ * @throws {TypeError} If the value is not a negative integer
  */
 export const asNegativeInt = castType;
 
 /**
- * Namespace providing type-safe arithmetic operations for negative integers.
+ * Namespace providing type-safe operations for the `NegativeInt` branded type.
  *
- * NegativeInt represents integers that are strictly less than zero (`<= -1`).
- * Operations that stay within the negative integers (such as `add`) 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 `NegativeInt` type represents a negative integer. Division (`div`) uses
+ * floor division.
+ *
+ * Unlike `SafeInt`, `NegativeInt` allows values outside the safe integer range
+ * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's
+ * `number` type.
  */
 export const NegativeInt = {
   /**
-   * Type guard to check if a value is a NegativeInt.
+   * Type guard that checks if a value is a negative integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a negative integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a negative integer, `false` otherwise
+   * @see {@link isNegativeInt} for usage examples
    */
   is,
 
   /**
-   * The maximum value for a negative integer.
-   *
-   * @readonly
+   * The largest value representable as `NegativeInt`.
    */
   MAX_VALUE,
 
   /**
    * Returns the absolute value of a negative integer.
    *
-   * @param a The negative integer.
-   * @returns The absolute value as a PositiveInt.
+   * The result is non-negative and keeps the `NegativeInt` brand. Note that
+   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
+   * use `SafeInt` for guaranteed precision.
+   *
+   * @param a - The negative integer value
+   * @returns The absolute value as a non-negative `NegativeInt`
    */
   abs,
 
   /**
-   * Returns the smaller of two negative integers.
+   * Returns the smallest of the given negative integers.
    *
-   * @param a The first negative integer.
-   * @param b The second negative integer.
-   * @returns The minimum value as a NegativeInt.
+   * @param values - The negative integers to compare (at least one required)
+   * @returns The smallest value as a `NegativeInt`
    */
   min: min_,
 
   /**
-   * Returns the larger of two negative integers.
+   * Returns the largest of the given negative integers.
    *
-   * @param a The first negative integer.
-   * @param b The second negative integer.
-   * @returns The maximum value as a NegativeInt.
+   * @param values - The negative integers to compare (at least one required)
+   * @returns The largest value as a `NegativeInt`
    */
   max: max_,
 
   /**
-   * Clamps a number to the negative integer range.
+   * Clamps a `number` into the `NegativeInt` 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 `[-∞, -1]` as a NegativeInt.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NegativeInt`
    */
   clamp,
 
   /**
-   * Generates a random NegativeInt value within the valid range.
+   * Generates a random `NegativeInt` within the given range.
    *
-   * @returns A random negative integer.
+   * The range is inclusive on both ends.
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NegativeInt` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a negative integer to the power of another negative integer.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeInt` (floored
+   * to an integer).
    *
-   * @param a The base negative integer.
-   * @param b The exponent negative integer.
-   * @returns `a ** b` clamped to the negative integer range.
+   * @param a - The base negative integer
+   * @param b - The exponent negative integer
+   * @returns `a ** b` as a `NegativeInt`
    */
   pow,
 
   /**
-   * Adds two negative integers.
+   * Adds two negative integers, returning `a + b` as a `NegativeInt`.
    *
-   * @param a The first negative integer.
-   * @param b The second negative integer.
-   * @returns `a + b` as a NegativeInt.
+   * @param a - The first negative integer
+   * @param b - The second negative integer
+   * @returns The sum of `a` and `b` as a `NegativeInt`
    */
   add,
 
   /**
-   * Subtracts one negative integer from another.
-   *
-   * The mathematical result can be positive, so it is clamped to the negative
-   * integer range (maximum `-1`).
+   * Subtracts two negative integers, returning `a - b` as a `NegativeInt`.
    *
-   * @param a The minuend negative integer.
-   * @param b The subtrahend negative integer.
-   * @returns `a - b` clamped to the negative integer range.
+   * @param a - The first negative integer
+   * @param b - The second negative integer
+   * @returns The difference of `a` and `b` as a `NegativeInt`
    */
   sub,
 } as const;

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;