ts-data-forge 11.0.0 → 11.0.1

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

@@ -1,7 +1,11 @@
 import { type Uint as TtfImported_Uint } from 'ts-type-forge';
 export type Uint = TtfImported_Uint;
 /**
- * Checks if a number is a Uint.
+ * Type guard that checks if a value is a non-negative integer.
+ *
+ * Returns `true` for a non-negative integer — a value with no fractional
+ * component, including values outside the safe integer range (unlike
+ * `SafeInt`).
  *
  * @example
  *
@@ -13,12 +17,15 @@ export type Uint = TtfImported_Uint;
  * assert.isTrue(Uint.is(0));
  * ```
  *
- * @param value The value to check.
- * @returns `true` if the value is a Uint, `false` otherwise.
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative integer, `false` otherwise
  */
 export declare const isUint: (a: number) => a is import("ts-type-forge").NonNegativeInt;
 /**
- * Casts a number to a Uint type.
+ * Casts a `number` to the `Uint` branded type.
+ *
+ * Validates that the value is a non-negative integer and returns it with the
+ * `Uint` brand. Throws a `TypeError` otherwise.
  *
  * @example
  *
@@ -30,9 +37,9 @@ export declare const isUint: (a: number) => a is import("ts-type-forge").NonNega
  * assert.isTrue(Uint.is(branded));
  * ```
  *
- * @param value The value to cast.
- * @returns The value as a Uint type.
- * @throws {TypeError} If the value is not a non-negative integer.
+ * @param value - The value to cast
+ * @returns The value as an `Uint`
+ * @throws {TypeError} If the value is not a non-negative integer
  */
 export declare const asUint: <N extends number>(x: N) => number & {
     readonly "> -2^16": true;
@@ -47,15 +54,18 @@ export declare const asUint: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for unsigned integers.
+ * Namespace providing type-safe operations for the `Uint` branded type.
+ *
+ * The `Uint` type represents a non-negative integer. Division (`div`) uses
+ * floor division.
  *
- * All operations maintain the non-negative constraint by clamping negative
- * results to 0. This ensures that all arithmetic preserves the unsigned integer
- * property.
+ * Unlike `SafeInt`, `Uint` allows values outside the safe integer range (±2^53
+ * − 1), so very large magnitudes may lose precision in JavaScript's `number`
+ * type.
  */
 export declare const Uint: {
     /**
-     * Type guard to check if a value is a Uint.
+     * Type guard that checks if a value is a non-negative integer.
      *
      * @example
      *
@@ -67,19 +77,17 @@ export declare const Uint: {
      * assert.isTrue(Uint.is(0));
      * ```
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-negative integer, `false` otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-negative integer, `false` otherwise
      * @see {@link isUint} for usage examples
      */
     readonly is: (a: number) => a is import("ts-type-forge").NonNegativeInt;
     /**
-     * The minimum value for an unsigned integer.
-     *
-     * @readonly
+     * The smallest value representable as `Uint`.
      */
     readonly MIN_VALUE: 0;
     /**
-     * Returns the smaller of two Uint values.
+     * Returns the smallest of the given non-negative integers.
      *
      * @example
      *
@@ -89,13 +97,12 @@ export declare const Uint: {
      * assert.isTrue(smallest === 3);
      * ```
      *
-     * @param a The first Uint.
-     * @param b The second Uint.
-     * @returns The minimum value as a Uint.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The smallest value as an `Uint`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>[]) => import("ts-type-forge").NonNegativeInt;
     /**
-     * Returns the larger of two Uint values.
+     * Returns the largest of the given non-negative integers.
      *
      * @example
      *
@@ -105,13 +112,13 @@ export declare const Uint: {
      * assert.isTrue(largest === 7);
      * ```
      *
-     * @param a The first Uint.
-     * @param b The second Uint.
-     * @returns The maximum value as a Uint.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The largest value as an `Uint`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>[]) => import("ts-type-forge").NonNegativeInt;
     /**
-     * Clamps a number to the Uint range (non-negative).
+     * Clamps a `number` into the `Uint` range, rounding to the nearest integer
+     * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
      * @example
      *
@@ -125,12 +132,14 @@ export declare const Uint: {
      * assert.isTrue(clampedPositive === 42);
      * ```
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, +∞) as a Uint.
+     * @param value - The value to clamp
+     * @returns The clamped value as an `Uint`
      */
     readonly clamp: (x: number) => import("ts-type-forge").NonNegativeInt;
     /**
-     * Generates a random Uint value.
+     * Generates a random `Uint` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
      * @example
      *
@@ -146,11 +155,14 @@ export declare const Uint: {
      * assert.isTrue(randomValue >= 0 && randomValue <= 3);
      * ```
      *
-     * @returns A random non-negative integer as a Uint.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `Uint` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt> | undefined, max?: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt> | undefined) => import("ts-type-forge").NonNegativeInt;
     /**
-     * Raises a Uint to the power of another Uint.
+     * Raises `a` to the power `b`, returning `a ** b` as an `Uint` (floored to an
+     * integer).
      *
      * @example
      *
@@ -164,13 +176,13 @@ export declare const Uint: {
      * assert.isTrue(power === 32);
      * ```
      *
-     * @param a The base Uint.
-     * @param b The exponent Uint.
-     * @returns `a ** b` clamped to [0, +∞) as a Uint.
+     * @param a - The base non-negative integer
+     * @param b - The exponent non-negative integer
+     * @returns `a ** b` as an `Uint`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>) => import("ts-type-forge").NonNegativeInt;
     /**
-     * Adds two Uint values.
+     * Adds two non-negative integers, returning `a + b` as an `Uint`.
      *
      * @example
      *
@@ -180,13 +192,13 @@ export declare const Uint: {
      * assert.isTrue(sum === 13);
      * ```
      *
-     * @param a The first Uint.
-     * @param b The second Uint.
-     * @returns `a + b` clamped to [0, +∞) as a Uint.
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The sum of `a` and `b` as an `Uint`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>) => import("ts-type-forge").NonNegativeInt;
     /**
-     * Subtracts one Uint from another.
+     * Subtracts two non-negative integers, returning `a - b` as an `Uint`.
      *
      * @example
      *
@@ -196,13 +208,13 @@ export declare const Uint: {
      * assert.isTrue(difference === 0);
      * ```
      *
-     * @param a The minuend Uint.
-     * @param b The subtrahend Uint.
-     * @returns `a - b` clamped to [0, +∞) as a Uint (minimum 0).
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The difference of `a` and `b` as an `Uint`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>) => import("ts-type-forge").NonNegativeInt;
     /**
-     * Multiplies two Uint values.
+     * Multiplies two non-negative integers, returning `a * b` as an `Uint`.
      *
      * @example
      *
@@ -212,13 +224,14 @@ export declare const Uint: {
      * assert.isTrue(product === 42);
      * ```
      *
-     * @param a The first Uint.
-     * @param b The second Uint.
-     * @returns `a * b` clamped to [0, +∞) as a Uint.
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The product of `a` and `b` as an `Uint`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>) => import("ts-type-forge").NonNegativeInt;
     /**
-     * Divides one Uint 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 an `Uint`.
      *
      * @example
      *
@@ -228,9 +241,9 @@ export declare const Uint: {
      * assert.isTrue(quotient === 2);
      * ```
      *
-     * @param a The dividend Uint.
-     * @param b The divisor Uint.
-     * @returns `⌊a / b⌋` clamped to [0, +∞) as a Uint.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as an `Uint`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>, y: 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/uint.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"uint.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/uint.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,IAAI,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAI9D,MAAM,MAAM,IAAI,GAAG,gBAAgB,CAAC;AA8BpC;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,MAAM,4DAAK,CAAC;AAEzB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;MAAW,CAAC;AAE/B;;;;;;GAMG;AACH,eAAO,MAAM,IAAI;IACf;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;OAIG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"uint.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/uint.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,IAAI,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAI9D,MAAM,MAAM,IAAI,GAAG,gBAAgB,CAAC;AA8BpC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,MAAM,4DAAK,CAAC;AAEzB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;MAAW,CAAC;AAE/B;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI;IACf;;;;;;;;;;;;;;;;OAgBG;;IAGH;;OAEG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;OAeG;;;;;;;;;;;;;;CAEK,CAAC"}

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

@@ -24,7 +24,7 @@ const isUint = is;
 const asUint = castType;
 const Uint = {
   /**
-   * Type guard to check if a value is a Uint.
+   * Type guard that checks if a value is a non-negative integer.
    *
    * @example
    *
@@ -36,19 +36,17 @@ const Uint = {
    * assert.isTrue(Uint.is(0));
    * ```
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-negative integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-negative integer, `false` otherwise
    * @see {@link isUint} for usage examples
    */
   is,
   /**
-   * The minimum value for an unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `Uint`.
    */
   MIN_VALUE,
   /**
-   * Returns the smaller of two Uint values.
+   * Returns the smallest of the given non-negative integers.
    *
    * @example
    *
@@ -58,13 +56,12 @@ const Uint = {
    * assert.isTrue(smallest === 3);
    * ```
    *
-   * @param a The first Uint.
-   * @param b The second Uint.
-   * @returns The minimum value as a Uint.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The smallest value as an `Uint`
    */
   min: min_,
   /**
-   * Returns the larger of two Uint values.
+   * Returns the largest of the given non-negative integers.
    *
    * @example
    *
@@ -74,13 +71,13 @@ const Uint = {
    * assert.isTrue(largest === 7);
    * ```
    *
-   * @param a The first Uint.
-   * @param b The second Uint.
-   * @returns The maximum value as a Uint.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The largest value as an `Uint`
    */
   max: max_,
   /**
-   * Clamps a number to the Uint range (non-negative).
+   * Clamps a `number` into the `Uint` range, rounding to the nearest integer
+   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
    * @example
    *
@@ -94,12 +91,14 @@ const Uint = {
    * assert.isTrue(clampedPositive === 42);
    * ```
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, +∞) as a Uint.
+   * @param value - The value to clamp
+   * @returns The clamped value as an `Uint`
    */
   clamp,
   /**
-   * Generates a random Uint value.
+   * Generates a random `Uint` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -115,11 +114,14 @@ const Uint = {
    * assert.isTrue(randomValue >= 0 && randomValue <= 3);
    * ```
    *
-   * @returns A random non-negative integer as a Uint.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Uint` in `[min, max]`
    */
   random,
   /**
-   * Raises a Uint to the power of another Uint.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Uint` (floored to an
+   * integer).
    *
    * @example
    *
@@ -133,13 +135,13 @@ const Uint = {
    * assert.isTrue(power === 32);
    * ```
    *
-   * @param a The base Uint.
-   * @param b The exponent Uint.
-   * @returns `a ** b` clamped to [0, +∞) as a Uint.
+   * @param a - The base non-negative integer
+   * @param b - The exponent non-negative integer
+   * @returns `a ** b` as an `Uint`
    */
   pow,
   /**
-   * Adds two Uint values.
+   * Adds two non-negative integers, returning `a + b` as an `Uint`.
    *
    * @example
    *
@@ -149,13 +151,13 @@ const Uint = {
    * assert.isTrue(sum === 13);
    * ```
    *
-   * @param a The first Uint.
-   * @param b The second Uint.
-   * @returns `a + b` clamped to [0, +∞) as a Uint.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The sum of `a` and `b` as an `Uint`
    */
   add,
   /**
-   * Subtracts one Uint from another.
+   * Subtracts two non-negative integers, returning `a - b` as an `Uint`.
    *
    * @example
    *
@@ -165,13 +167,13 @@ const Uint = {
    * assert.isTrue(difference === 0);
    * ```
    *
-   * @param a The minuend Uint.
-   * @param b The subtrahend Uint.
-   * @returns `a - b` clamped to [0, +∞) as a Uint (minimum 0).
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The difference of `a` and `b` as an `Uint`
    */
   sub,
   /**
-   * Multiplies two Uint values.
+   * Multiplies two non-negative integers, returning `a * b` as an `Uint`.
    *
    * @example
    *
@@ -181,13 +183,14 @@ const Uint = {
    * assert.isTrue(product === 42);
    * ```
    *
-   * @param a The first Uint.
-   * @param b The second Uint.
-   * @returns `a * b` clamped to [0, +∞) as a Uint.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The product of `a` and `b` as an `Uint`
    */
   mul,
   /**
-   * Divides one Uint 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 an `Uint`.
    *
    * @example
    *
@@ -197,9 +200,9 @@ const Uint = {
    * assert.isTrue(quotient === 2);
    * ```
    *
-   * @param a The dividend Uint.
-   * @param b The divisor Uint.
-   * @returns `⌊a / b⌋` clamped to [0, +∞) as a Uint.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Uint`
    */
   div
 };

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

@@ -1 +1 @@
-{"version":3,"file":"uint.mjs","sources":["../../../src/number/branded-types/uint.mts"],"sourcesContent":["import { type Uint as TtfImported_Uint } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Uint = TtfImported_Uint;\n\ntype ElementType = Uint;\n\nconst typeNameInMessage = 'a non-negative integer';\n\nconst {\n  MIN_VALUE,\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  0,\n  number\n>({\n  integerOrSafeInteger: 'Integer',\n  MIN_VALUE: 0,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a Uint.\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isUint(4));\n *\n * assert.isFalse(isUint(-1));\n *\n * assert.isTrue(Uint.is(0));\n * ```\n *\n * @param value The value to check.\n * @returns `true` if the value is a Uint, `false` otherwise.\n */\nexport const isUint = is;\n\n/**\n * Casts a number to a Uint type.\n *\n * @example\n *\n * ```ts\n * const branded = asUint(12);\n *\n * assert.isTrue(branded === 12);\n *\n * assert.isTrue(Uint.is(branded));\n * ```\n *\n * @param value The value to cast.\n * @returns The value as a Uint type.\n * @throws {TypeError} If the value is not a non-negative integer.\n */\nexport const asUint = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for unsigned integers.\n *\n * All operations maintain the non-negative constraint by clamping negative\n * results to 0. This ensures that all arithmetic preserves the unsigned integer\n * property.\n */\nexport const Uint = {\n  /**\n   * Type guard to check if a value is a Uint.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isUint(4));\n   *\n   * assert.isFalse(isUint(-1));\n   *\n   * assert.isTrue(Uint.is(0));\n   * ```\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-negative integer, `false` otherwise.\n   * @see {@link isUint} for usage examples\n   */\n  is,\n\n  /**\n   * The minimum value for an unsigned integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smaller of two Uint values.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = Uint.min(asUint(7), asUint(3));\n   *\n   * assert.isTrue(smallest === 3);\n   * ```\n   *\n   * @param a The first Uint.\n   * @param b The second Uint.\n   * @returns The minimum value as a Uint.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two Uint values.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = Uint.max(asUint(7), asUint(3));\n   *\n   * assert.isTrue(largest === 7);\n   * ```\n   *\n   * @param a The first Uint.\n   * @param b The second Uint.\n   * @returns The maximum value as a Uint.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the Uint range (non-negative).\n   *\n   * @example\n   *\n   * ```ts\n   * const clampedNegative = Uint.clamp(-5);\n   *\n   * const clampedPositive = Uint.clamp(42);\n   *\n   * assert.isTrue(clampedNegative === 0);\n   *\n   * assert.isTrue(clampedPositive === 42);\n   * ```\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [0, +∞) as a Uint.\n   */\n  clamp,\n\n  /**\n   * Generates a random Uint value.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asUint(0);\n   *\n   * const max = asUint(3);\n   *\n   * const randomValue = Uint.random(min, max);\n   *\n   * assert.isTrue(Uint.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= 0 && randomValue <= 3);\n   * ```\n   *\n   * @returns A random non-negative integer as a Uint.\n   */\n  random,\n\n  /**\n   * Raises a Uint to the power of another Uint.\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asUint(2);\n   *\n   * const exponent = asUint(5);\n   *\n   * const power = Uint.pow(base, exponent);\n   *\n   * assert.isTrue(power === 32);\n   * ```\n   *\n   * @param a The base Uint.\n   * @param b The exponent Uint.\n   * @returns `a ** b` clamped to [0, +∞) as a Uint.\n   */\n  pow,\n\n  /**\n   * Adds two Uint values.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = Uint.add(asUint(5), asUint(8));\n   *\n   * assert.isTrue(sum === 13);\n   * ```\n   *\n   * @param a The first Uint.\n   * @param b The second Uint.\n   * @returns `a + b` clamped to [0, +∞) as a Uint.\n   */\n  add,\n\n  /**\n   * Subtracts one Uint from another.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = Uint.sub(asUint(5), asUint(8));\n   *\n   * assert.isTrue(difference === 0);\n   * ```\n   *\n   * @param a The minuend Uint.\n   * @param b The subtrahend Uint.\n   * @returns `a - b` clamped to [0, +∞) as a Uint (minimum 0).\n   */\n  sub,\n\n  /**\n   * Multiplies two Uint values.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = Uint.mul(asUint(7), asUint(6));\n   *\n   * assert.isTrue(product === 42);\n   * ```\n   *\n   * @param a The first Uint.\n   * @param b The second Uint.\n   * @returns `a * b` clamped to [0, +∞) as a Uint.\n   */\n  mul,\n\n  /**\n   * Divides one Uint by another using floor division.\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = Uint.div(asUint(10), asUint(4));\n   *\n   * assert.isTrue(quotient === 2);\n   * ```\n   *\n   * @param a The dividend Uint.\n   * @param b The divisor Uint.\n   * @returns `⌊a / b⌋` clamped to [0, +∞) as a Uint.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Uint,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative'\n  >\n>('=');\n\nexpectType<\n  typeof Uint,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,wBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;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,SAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAkBH,MAAM,MAAA,GAAS;AAmBf,MAAM,MAAA,GAAS;AASf,MAAM,IAAA,GAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBlB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA;AACF;;;;"}
+{"version":3,"file":"uint.mjs","sources":["../../../src/number/branded-types/uint.mts"],"sourcesContent":["import { type Uint as TtfImported_Uint } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Uint = TtfImported_Uint;\n\ntype ElementType = Uint;\n\nconst typeNameInMessage = 'a non-negative integer';\n\nconst {\n  MIN_VALUE,\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  0,\n  number\n>({\n  integerOrSafeInteger: 'Integer',\n  MIN_VALUE: 0,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative integer.\n *\n * Returns `true` for a non-negative integer — a value with no fractional\n * component, including values outside the safe integer range (unlike\n * `SafeInt`).\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isUint(4));\n *\n * assert.isFalse(isUint(-1));\n *\n * assert.isTrue(Uint.is(0));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative integer, `false` otherwise\n */\nexport const isUint = is;\n\n/**\n * Casts a `number` to the `Uint` branded type.\n *\n * Validates that the value is a non-negative integer and returns it with the\n * `Uint` brand. Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asUint(12);\n *\n * assert.isTrue(branded === 12);\n *\n * assert.isTrue(Uint.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as an `Uint`\n * @throws {TypeError} If the value is not a non-negative integer\n */\nexport const asUint = castType;\n\n/**\n * Namespace providing type-safe operations for the `Uint` branded type.\n *\n * The `Uint` type represents a non-negative integer. Division (`div`) uses\n * floor division.\n *\n * Unlike `SafeInt`, `Uint` allows values outside the safe integer range (±2^53\n * − 1), so very large magnitudes may lose precision in JavaScript's `number`\n * type.\n */\nexport const Uint = {\n  /**\n   * Type guard that checks if a value is a non-negative integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isUint(4));\n   *\n   * assert.isFalse(isUint(-1));\n   *\n   * assert.isTrue(Uint.is(0));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative integer, `false` otherwise\n   * @see {@link isUint} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `Uint`.\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = Uint.min(asUint(7), asUint(3));\n   *\n   * assert.isTrue(smallest === 3);\n   * ```\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The smallest value as an `Uint`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = Uint.max(asUint(7), asUint(3));\n   *\n   * assert.isTrue(largest === 7);\n   * ```\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The largest value as an `Uint`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `Uint` range, rounding to the nearest integer\n   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @example\n   *\n   * ```ts\n   * const clampedNegative = Uint.clamp(-5);\n   *\n   * const clampedPositive = Uint.clamp(42);\n   *\n   * assert.isTrue(clampedNegative === 0);\n   *\n   * assert.isTrue(clampedPositive === 42);\n   * ```\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as an `Uint`\n   */\n  clamp,\n\n  /**\n   * Generates a random `Uint` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asUint(0);\n   *\n   * const max = asUint(3);\n   *\n   * const randomValue = Uint.random(min, max);\n   *\n   * assert.isTrue(Uint.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= 0 && randomValue <= 3);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `Uint` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as an `Uint` (floored to an\n   * integer).\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asUint(2);\n   *\n   * const exponent = asUint(5);\n   *\n   * const power = Uint.pow(base, exponent);\n   *\n   * assert.isTrue(power === 32);\n   * ```\n   *\n   * @param a - The base non-negative integer\n   * @param b - The exponent non-negative integer\n   * @returns `a ** b` as an `Uint`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as an `Uint`.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = Uint.add(asUint(5), asUint(8));\n   *\n   * assert.isTrue(sum === 13);\n   * ```\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The sum of `a` and `b` as an `Uint`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as an `Uint`.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = Uint.sub(asUint(5), asUint(8));\n   *\n   * assert.isTrue(difference === 0);\n   * ```\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The difference of `a` and `b` as an `Uint`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as an `Uint`.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = Uint.mul(asUint(7), asUint(6));\n   *\n   * assert.isTrue(product === 42);\n   * ```\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The product of `a` and `b` as an `Uint`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the\n   * result is `a / b` rounded toward negative infinity, as an `Uint`.\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = Uint.div(asUint(10), asUint(4));\n   *\n   * assert.isTrue(quotient === 2);\n   * ```\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as an `Uint`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Uint,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative'\n  >\n>('=');\n\nexpectType<\n  typeof Uint,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,wBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;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,SAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAsBH,MAAM,MAAA,GAAS;AAsBf,MAAM,MAAA,GAAS;AAYf,MAAM,IAAA,GAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBlB,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA;AACF;;;;"}