ts-data-forge 11.0.0 → 11.0.1

package/dist/number/branded-types/int32.d.mts

@@ -1,19 +1,24 @@
 import { type Int32 as TtfImported_Int32 } from 'ts-type-forge';
 export type Int32 = TtfImported_Int32;
 /**
- * Checks if a number is an Int32 (32-bit signed integer in the range [-2^31,
- * 2^31)).
+ * Type guard that checks if a value is an integer in [-2^31, 2^31).
  *
- * @param value The value to check.
- * @returns `true` if the value is an Int32, `false` otherwise.
+ * Returns `true` for an integer in [-2^31, 2^31) — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise
  */
 export declare const isInt32: (a: number) => a is TtfImported_Int32;
 /**
- * Casts a number to an Int32 type.
+ * Casts a `number` to the `Int32` branded type.
+ *
+ * Validates that the value is an integer in [-2^31, 2^31) and returns it with
+ * the `Int32` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as an Int32 type.
- * @throws {TypeError} If the value is not an integer in [-2^31, 2^31).
+ * @param value - The value to cast
+ * @returns The value as an `Int32`
+ * @throws {TypeError} If the value is not an integer in [-2^31, 2^31)
  */
 export declare const asInt32: <N extends number>(x: N) => number & {
     readonly "< 2^31": true;
@@ -28,107 +33,109 @@ export declare const asInt32: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 32-bit signed
- * integers.
+ * Namespace providing type-safe operations for the `Int32` branded type.
  *
- * All operations automatically clamp results to the valid Int32 range
- * [-2147483648, 2147483647]. This ensures that all arithmetic maintains the
- * 32-bit signed integer constraint, preventing overflow.
+ * The `Int32` type represents an integer in [-2^31, 2^31). Division (`div`)
+ * uses floor division.
  */
 export declare const Int32: {
     /**
-     * Type guard to check if a value is an Int32.
+     * Type guard that checks if a value is an integer in [-2^31, 2^31).
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a 32-bit signed integer, `false` otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise
+     * @see {@link isInt32} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_Int32;
     /**
-     * The minimum value for a 32-bit signed integer.
-     *
-     * @readonly
+     * The smallest value representable as `Int32`.
      */
     readonly MIN_VALUE: number;
     /**
-     * The maximum value for a 32-bit signed integer.
-     *
-     * @readonly
+     * The largest value representable as `Int32`.
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the absolute value of a 32-bit signed integer.
+     * Returns the absolute value of an integer in [-2^31, 2^31).
+     *
+     * The result is non-negative and keeps the `Int32` brand.
      *
-     * @param a The Int32 value.
-     * @returns The absolute value as an Int32, clamped to valid range.
+     * @param a - The integer value
+     * @returns The absolute value as a non-negative `Int32`
      */
     readonly abs: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int32>) => import("ts-type-forge").IntersectBrand<TtfImported_Int32, import("ts-type-forge").NonNegativeNumber>;
     /**
-     * Returns the smaller of two Int32 values.
+     * Returns the smallest of the given integers.
      *
-     * @param a The first Int32.
-     * @param b The second Int32.
-     * @returns The minimum value as an Int32.
+     * @param values - The integers to compare (at least one required)
+     * @returns The smallest value as an `Int32`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Int32>[]) => TtfImported_Int32;
     /**
-     * Returns the larger of two Int32 values.
+     * Returns the largest of the given integers.
      *
-     * @param a The first Int32.
-     * @param b The second Int32.
-     * @returns The maximum value as an Int32.
+     * @param values - The integers to compare (at least one required)
+     * @returns The largest value as an `Int32`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Int32>[]) => TtfImported_Int32;
     /**
-     * Clamps a number to the Int32 range.
+     * Clamps a `number` into the `Int32` 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 [-2147483648, 2147483647] as an Int32.
+     * @param value - The value to clamp
+     * @returns The clamped value as an `Int32`
      */
     readonly clamp: (x: number) => TtfImported_Int32;
     /**
-     * Generates a random Int32 value within the valid range.
+     * Generates a random `Int32` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random Int32 between MIN_VALUE and MAX_VALUE.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `Int32` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_Int32> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_Int32> | undefined) => TtfImported_Int32;
     /**
-     * Raises an Int32 to the power of another Int32.
+     * Raises `a` to the power `b`, returning `a ** b` as an `Int32` (floored to
+     * an integer).
      *
-     * @param a The base Int32.
-     * @param b The exponent Int32.
-     * @returns `a ** b` clamped to [-2147483648, 2147483647] as an Int32.
+     * @param a - The base integer
+     * @param b - The exponent integer
+     * @returns `a ** b` as an `Int32`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int32>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int32>) => TtfImported_Int32;
     /**
-     * Adds two Int32 values.
+     * Adds two integers, returning `a + b` as an `Int32`.
      *
-     * @param a The first Int32.
-     * @param b The second Int32.
-     * @returns `a + b` clamped to [-2147483648, 2147483647] as an Int32.
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The sum of `a` and `b` as an `Int32`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int32>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int32>) => TtfImported_Int32;
     /**
-     * Subtracts one Int32 from another.
+     * Subtracts two integers, returning `a - b` as an `Int32`.
      *
-     * @param a The minuend Int32.
-     * @param b The subtrahend Int32.
-     * @returns `a - b` clamped to [-2147483648, 2147483647] as an Int32.
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The difference of `a` and `b` as an `Int32`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int32>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int32>) => TtfImported_Int32;
     /**
-     * Multiplies two Int32 values.
+     * Multiplies two integers, returning `a * b` as an `Int32`.
      *
-     * @param a The first Int32.
-     * @param b The second Int32.
-     * @returns `a * b` clamped to [-2147483648, 2147483647] as an Int32.
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The product of `a` and `b` as an `Int32`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int32>, y: import("ts-type-forge").WithSmallInt<TtfImported_Int32>) => TtfImported_Int32;
     /**
-     * Divides one Int32 by another using floor division.
+     * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+     * b` rounded toward negative infinity, as an `Int32`.
      *
-     * @param a The dividend Int32.
-     * @param b The divisor Int32.
-     * @returns `⌊a / b⌋` clamped to [-2147483648, 2147483647] as an Int32.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as an `Int32`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int32>, y: -40 | -39 | -38 | -37 | -36 | -35 | -34 | -33 | -32 | -31 | -30 | -29 | -28 | -27 | -26 | -25 | -24 | -23 | -22 | -21 | -20 | -19 | -18 | -17 | -16 | -15 | -14 | -13 | -12 | -11 | -10 | -9 | -8 | -7 | -6 | -5 | -4 | -3 | -2 | -1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
         readonly "!=0": true;

package/dist/number/branded-types/int32.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,IAAI,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAIhE,MAAM,MAAM,KAAK,GAAG,iBAAiB,CAAC;AAgCtC;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,uCAAK,CAAC;AAE1B;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,IAAI,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAIhE,MAAM,MAAM,KAAK,GAAG,iBAAiB,CAAC;AAgCtC;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,uCAAK,CAAC;AAE1B;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;;;OAOG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/int32.mjs

@@ -26,98 +26,102 @@ const isInt32 = is;
 const asInt32 = castType;
 const Int32 = {
   /**
-   * Type guard to check if a value is an Int32.
+   * Type guard that checks if a value is an integer in [-2^31, 2^31).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 32-bit signed integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise
+   * @see {@link isInt32} for usage examples
    */
   is,
   /**
-   * The minimum value for a 32-bit signed integer.
-   *
-   * @readonly
+   * The smallest value representable as `Int32`.
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 32-bit signed integer.
-   *
-   * @readonly
+   * The largest value representable as `Int32`.
    */
   MAX_VALUE,
   /**
-   * Returns the absolute value of a 32-bit signed integer.
+   * Returns the absolute value of an integer in [-2^31, 2^31).
    *
-   * @param a The Int32 value.
-   * @returns The absolute value as an Int32, clamped to valid range.
+   * The result is non-negative and keeps the `Int32` brand.
+   *
+   * @param a - The integer value
+   * @returns The absolute value as a non-negative `Int32`
    */
   abs,
   /**
-   * Returns the smaller of two Int32 values.
+   * Returns the smallest of the given integers.
    *
-   * @param a The first Int32.
-   * @param b The second Int32.
-   * @returns The minimum value as an Int32.
+   * @param values - The integers to compare (at least one required)
+   * @returns The smallest value as an `Int32`
    */
   min: min_,
   /**
-   * Returns the larger of two Int32 values.
+   * Returns the largest of the given integers.
    *
-   * @param a The first Int32.
-   * @param b The second Int32.
-   * @returns The maximum value as an Int32.
+   * @param values - The integers to compare (at least one required)
+   * @returns The largest value as an `Int32`
    */
   max: max_,
   /**
-   * Clamps a number to the Int32 range.
+   * Clamps a `number` into the `Int32` 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 [-2147483648, 2147483647] as an Int32.
+   * @param value - The value to clamp
+   * @returns The clamped value as an `Int32`
    */
   clamp,
   /**
-   * Generates a random Int32 value within the valid range.
+   * Generates a random `Int32` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random Int32 between MIN_VALUE and MAX_VALUE.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Int32` in `[min, max]`
    */
   random,
   /**
-   * Raises an Int32 to the power of another Int32.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Int32` (floored to
+   * an integer).
    *
-   * @param a The base Int32.
-   * @param b The exponent Int32.
-   * @returns `a ** b` clamped to [-2147483648, 2147483647] as an Int32.
+   * @param a - The base integer
+   * @param b - The exponent integer
+   * @returns `a ** b` as an `Int32`
    */
   pow,
   /**
-   * Adds two Int32 values.
+   * Adds two integers, returning `a + b` as an `Int32`.
    *
-   * @param a The first Int32.
-   * @param b The second Int32.
-   * @returns `a + b` clamped to [-2147483648, 2147483647] as an Int32.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The sum of `a` and `b` as an `Int32`
    */
   add,
   /**
-   * Subtracts one Int32 from another.
+   * Subtracts two integers, returning `a - b` as an `Int32`.
    *
-   * @param a The minuend Int32.
-   * @param b The subtrahend Int32.
-   * @returns `a - b` clamped to [-2147483648, 2147483647] as an Int32.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The difference of `a` and `b` as an `Int32`
    */
   sub,
   /**
-   * Multiplies two Int32 values.
+   * Multiplies two integers, returning `a * b` as an `Int32`.
    *
-   * @param a The first Int32.
-   * @param b The second Int32.
-   * @returns `a * b` clamped to [-2147483648, 2147483647] as an Int32.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The product of `a` and `b` as an `Int32`
    */
   mul,
   /**
-   * Divides one Int32 by another using floor division.
+   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+   * b` rounded toward negative infinity, as an `Int32`.
    *
-   * @param a The dividend Int32.
-   * @param b The divisor Int32.
-   * @returns `⌊a / b⌋` clamped to [-2147483648, 2147483647] as an Int32.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Int32`
    */
   div
 };

package/dist/number/branded-types/int32.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"int32.mjs","sources":["../../../src/number/branded-types/int32.mts"],"sourcesContent":["import { type Int32 as TtfImported_Int32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Int32 = TtfImported_Int32;\n\ntype ElementType = Int32;\n\nconst typeNameInMessage = 'an integer in [-2^31, 2^31)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  abs,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: -(2 ** 31),\n  MAX_VALUE: 2 ** 31 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is an Int32 (32-bit signed integer in the range [-2^31,\n * 2^31)).\n *\n * @param value The value to check.\n * @returns `true` if the value is an Int32, `false` otherwise.\n */\nexport const isInt32 = is;\n\n/**\n * Casts a number to an Int32 type.\n *\n * @param value The value to cast.\n * @returns The value as an Int32 type.\n * @throws {TypeError} If the value is not an integer in [-2^31, 2^31).\n */\nexport const asInt32 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 32-bit signed\n * integers.\n *\n * All operations automatically clamp results to the valid Int32 range\n * [-2147483648, 2147483647]. This ensures that all arithmetic maintains the\n * 32-bit signed integer constraint, preventing overflow.\n */\nexport const Int32 = {\n  /**\n   * Type guard to check if a value is an Int32.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a 32-bit signed integer, `false` otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a 32-bit signed integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a 32-bit signed integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a 32-bit signed integer.\n   *\n   * @param a The Int32 value.\n   * @returns The absolute value as an Int32, clamped to valid range.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two Int32 values.\n   *\n   * @param a The first Int32.\n   * @param b The second Int32.\n   * @returns The minimum value as an Int32.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two Int32 values.\n   *\n   * @param a The first Int32.\n   * @param b The second Int32.\n   * @returns The maximum value as an Int32.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the Int32 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [-2147483648, 2147483647] as an Int32.\n   */\n  clamp,\n\n  /**\n   * Generates a random Int32 value within the valid range.\n   *\n   * @returns A random Int32 between MIN_VALUE and MAX_VALUE.\n   */\n  random,\n\n  /**\n   * Raises an Int32 to the power of another Int32.\n   *\n   * @param a The base Int32.\n   * @param b The exponent Int32.\n   * @returns `a ** b` clamped to [-2147483648, 2147483647] as an Int32.\n   */\n  pow,\n\n  /**\n   * Adds two Int32 values.\n   *\n   * @param a The first Int32.\n   * @param b The second Int32.\n   * @returns `a + b` clamped to [-2147483648, 2147483647] as an Int32.\n   */\n  add,\n\n  /**\n   * Subtracts one Int32 from another.\n   *\n   * @param a The minuend Int32.\n   * @param b The subtrahend Int32.\n   * @returns `a - b` clamped to [-2147483648, 2147483647] as an Int32.\n   */\n  sub,\n\n  /**\n   * Multiplies two Int32 values.\n   *\n   * @param a The first Int32.\n   * @param b The second Int32.\n   * @returns `a * b` clamped to [-2147483648, 2147483647] as an Int32.\n   */\n  mul,\n\n  /**\n   * Divides one Int32 by another using floor division.\n   *\n   * @param a The dividend Int32.\n   * @param b The divisor Int32.\n   * @returns `⌊a / b⌋` clamped to [-2147483648, 2147483647] as an Int32.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Int32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof Int32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,6BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,WAAO;AAAA,EAClB,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AASH,MAAM,OAAA,GAAU;AAShB,MAAM,OAAA,GAAU;AAUhB,MAAM,KAAA,GAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}
+{"version":3,"file":"int32.mjs","sources":["../../../src/number/branded-types/int32.mts"],"sourcesContent":["import { type Int32 as TtfImported_Int32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Int32 = TtfImported_Int32;\n\ntype ElementType = Int32;\n\nconst typeNameInMessage = 'an integer in [-2^31, 2^31)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  abs,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: -(2 ** 31),\n  MAX_VALUE: 2 ** 31 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is an integer in [-2^31, 2^31).\n *\n * Returns `true` for an integer in [-2^31, 2^31) — a value with no fractional\n * component.\n *\n * @param value - The value to check\n * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise\n */\nexport const isInt32 = is;\n\n/**\n * Casts a `number` to the `Int32` branded type.\n *\n * Validates that the value is an integer in [-2^31, 2^31) and returns it with\n * the `Int32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as an `Int32`\n * @throws {TypeError} If the value is not an integer in [-2^31, 2^31)\n */\nexport const asInt32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `Int32` branded type.\n *\n * The `Int32` type represents an integer in [-2^31, 2^31). Division (`div`)\n * uses floor division.\n */\nexport const Int32 = {\n  /**\n   * Type guard that checks if a value is an integer in [-2^31, 2^31).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise\n   * @see {@link isInt32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `Int32`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `Int32`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of an integer in [-2^31, 2^31).\n   *\n   * The result is non-negative and keeps the `Int32` brand.\n   *\n   * @param a - The integer value\n   * @returns The absolute value as a non-negative `Int32`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given integers.\n   *\n   * @param values - The integers to compare (at least one required)\n   * @returns The smallest value as an `Int32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given integers.\n   *\n   * @param values - The integers to compare (at least one required)\n   * @returns The largest value as an `Int32`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `Int32` range, rounding to the nearest integer\n   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as an `Int32`\n   */\n  clamp,\n\n  /**\n   * Generates a random `Int32` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `Int32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as an `Int32` (floored to\n   * an integer).\n   *\n   * @param a - The base integer\n   * @param b - The exponent integer\n   * @returns `a ** b` as an `Int32`\n   */\n  pow,\n\n  /**\n   * Adds two integers, returning `a + b` as an `Int32`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The sum of `a` and `b` as an `Int32`\n   */\n  add,\n\n  /**\n   * Subtracts two integers, returning `a - b` as an `Int32`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The difference of `a` and `b` as an `Int32`\n   */\n  sub,\n\n  /**\n   * Multiplies two integers, returning `a * b` as an `Int32`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The product of `a` and `b` as an `Int32`\n   */\n  mul,\n\n  /**\n   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /\n   * b` rounded toward negative infinity, as an `Int32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as an `Int32`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Int32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof Int32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,6BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,WAAO;AAAA,EAClB,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,OAAA,GAAU;AAYhB,MAAM,OAAA,GAAU;AAQhB,MAAM,KAAA,GAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}

package/dist/number/branded-types/negative-finite-number.d.mts

@@ -4,18 +4,24 @@ import { PositiveFiniteNumber } from './positive-finite-number.mjs';
 export type NegativeFiniteNumber = TtfImported_NegativeFiniteNumber;
 type ElementType = NegativeFiniteNumber;
 /**
- * Checks if a number is a NegativeFiniteNumber (a finite number `< 0`).
+ * 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 NegativeFiniteNumber, `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 negative finite number, `false` otherwise
  */
 export declare const isNegativeFiniteNumber: (a: number) => a is TtfImported_NegativeFiniteNumber;
 /**
- * Casts a number to a NegativeFiniteNumber type.
+ * Casts a `number` to the `NegativeFiniteNumber` branded type.
+ *
+ * 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 type.
- * @throws {TypeError} If the value is not a negative finite number.
+ * @param value - The value to cast
+ * @returns The value as a `NegativeFiniteNumber`
+ * @throws {TypeError} If the value is not a negative finite number
  */
 export declare const asNegativeFiniteNumber: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -31,111 +37,114 @@ export declare const asNegativeFiniteNumber: <N extends number>(x: N) => number
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * 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 declare 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
      */
     readonly is: (a: number) => a is TtfImported_NegativeFiniteNumber;
     /**
-     * The maximum value for a negative finite number.
-     *
-     * @readonly
+     * The largest value representable as `NegativeFiniteNumber`.
      */
     readonly MAX_VALUE: number;
     /**
      * 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`
      */
     readonly abs: (x: ElementType) => PositiveFiniteNumber;
     /**
-     * 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`
      */
     readonly min: (...values: readonly TtfImported_NegativeFiniteNumber[]) => TtfImported_NegativeFiniteNumber;
     /**
-     * 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`
      */
     readonly max: (...values: readonly TtfImported_NegativeFiniteNumber[]) => TtfImported_NegativeFiniteNumber;
     /**
-     * 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`
      */
     readonly clamp: (x: number) => TtfImported_NegativeFiniteNumber;
     /**
-     * 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
      */
     readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * 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
      */
     readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * 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
      */
     readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * Generates a random NegativeFiniteNumber value.
+     * Generates a random `NegativeFiniteNumber` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random negative finite number.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NegativeFiniteNumber` in `[min, max]`
      */
     readonly random: (min?: TtfImported_NegativeFiniteNumber | undefined, max?: TtfImported_NegativeFiniteNumber | undefined) => TtfImported_NegativeFiniteNumber;
     /**
-     * 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`
      */
     readonly pow: (x: TtfImported_NegativeFiniteNumber, y: TtfImported_NegativeFiniteNumber) => TtfImported_NegativeFiniteNumber;
     /**
-     * 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`
      */
     readonly add: (x: TtfImported_NegativeFiniteNumber, y: TtfImported_NegativeFiniteNumber) => TtfImported_NegativeFiniteNumber;
     /**
-     * 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`
      */
     readonly sub: (x: TtfImported_NegativeFiniteNumber, y: TtfImported_NegativeFiniteNumber) => TtfImported_NegativeFiniteNumber;
 };

package/dist/number/branded-types/negative-finite-number.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"negative-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/negative-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,oBAAoB,IAAI,gCAAgC,EAAE,MAAM,eAAe,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEpE,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AAEpE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAkExC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,sDAAK,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;sBA/EW,WAAW,KAAG,oBAAoB;IAkFhD;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;wBA7GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IA+G3D;;;;;OAKG;uBA/GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA+GC;;;;;OAKG;wBA7GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA6GC;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;OASG;;CAEK,CAAC"}
+{"version":3,"file":"negative-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/negative-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,oBAAoB,IAAI,gCAAgC,EAAE,MAAM,eAAe,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEpE,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AAEpE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAyDxC;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,sDAAK,CAAC;AAEzC;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;;;OAOG;sBAlFW,WAAW,KAAG,oBAAoB;IAqFhD;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;wBAhHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAkH3D;;;;;;OAMG;uBAnHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAmHC;;;;;;OAMG;wBAlHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAkHC;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}