ts-data-forge 9.0.0 → 9.0.1

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

@@ -1,128 +1,118 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a non-negative integer less than 2^16';
-const { MAX_VALUE, MIN_VALUE, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'SafeInteger',
-    MIN_VALUE: 0,
-    MAX_VALUE: 2 ** 16 - 1,
-    typeNameInMessage,
+const typeNameInMessage = "a non-negative integer less than 2^16";
+const {
+  MAX_VALUE,
+  MIN_VALUE,
+  add,
+  castType,
+  clamp,
+  div,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "SafeInteger",
+  MIN_VALUE: 0,
+  MAX_VALUE: 2 ** 16 - 1,
+  typeNameInMessage
 });
-/**
- * Checks if a number is a Uint16 (16-bit unsigned integer in the range [0,
- * 2^16)).
- *
- * @param value The value to check.
- * @returns `true` if the value is a Uint16, `false` otherwise.
- */
 const isUint16 = is;
-/**
- * Casts a number to a Uint16 type.
- *
- * @param value The value to cast.
- * @returns The value as a Uint16 type.
- * @throws {TypeError} If the value is not a non-negative integer less than
- *   2^16.
- */
 const asUint16 = castType;
-/**
- * Namespace providing type-safe arithmetic operations for 16-bit unsigned
- * integers.
- *
- * All operations automatically clamp results to the valid Uint16 range [0,
- * 65535]. This ensures that all arithmetic maintains the 16-bit unsigned
- * integer constraint, with negative results clamped to 0 and overflow results
- * clamped to MAX_VALUE.
- */
 const Uint16 = {
-    /**
-     * Type guard to check if a value is a Uint16.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a 16-bit unsigned integer, `false`
-     *   otherwise.
-     */
-    is,
-    /**
-     * The minimum value for a 16-bit unsigned integer.
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * The maximum value for a 16-bit unsigned integer.
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the smaller of two Uint16 values.
-     *
-     * @param a The first Uint16.
-     * @param b The second Uint16.
-     * @returns The minimum value as a Uint16.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two Uint16 values.
-     *
-     * @param a The first Uint16.
-     * @param b The second Uint16.
-     * @returns The maximum value as a Uint16.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the Uint16 range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, 65535] as a Uint16.
-     */
-    clamp,
-    /**
-     * Generates a random Uint16 value within the valid range.
-     *
-     * @returns A random Uint16 between 0 and 65535.
-     */
-    random,
-    /**
-     * Raises a Uint16 to the power of another Uint16.
-     *
-     * @param a The base Uint16.
-     * @param b The exponent Uint16.
-     * @returns `a ** b` clamped to [0, 65535] as a Uint16.
-     */
-    pow,
-    /**
-     * Adds two Uint16 values.
-     *
-     * @param a The first Uint16.
-     * @param b The second Uint16.
-     * @returns `a + b` clamped to [0, 65535] as a Uint16.
-     */
-    add,
-    /**
-     * Subtracts one Uint16 from another.
-     *
-     * @param a The minuend Uint16.
-     * @param b The subtrahend Uint16.
-     * @returns `a - b` clamped to [0, 65535] as a Uint16 (minimum 0).
-     */
-    sub,
-    /**
-     * Multiplies two Uint16 values.
-     *
-     * @param a The first Uint16.
-     * @param b The second Uint16.
-     * @returns `a * b` clamped to [0, 65535] as a Uint16.
-     */
-    mul,
-    /**
-     * Divides one Uint16 by another using floor division.
-     *
-     * @param a The dividend Uint16.
-     * @param b The divisor Uint16.
-     * @returns `⌊a / b⌋` clamped to [0, 65535] as a Uint16.
-     */
-    div,
+  /**
+   * Type guard to check if a value is a Uint16.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a 16-bit unsigned integer, `false`
+   *   otherwise.
+   */
+  is,
+  /**
+   * The minimum value for a 16-bit unsigned integer.
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * The maximum value for a 16-bit unsigned integer.
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the smaller of two Uint16 values.
+   *
+   * @param a The first Uint16.
+   * @param b The second Uint16.
+   * @returns The minimum value as a Uint16.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two Uint16 values.
+   *
+   * @param a The first Uint16.
+   * @param b The second Uint16.
+   * @returns The maximum value as a Uint16.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the Uint16 range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to [0, 65535] as a Uint16.
+   */
+  clamp,
+  /**
+   * Generates a random Uint16 value within the valid range.
+   *
+   * @returns A random Uint16 between 0 and 65535.
+   */
+  random,
+  /**
+   * Raises a Uint16 to the power of another Uint16.
+   *
+   * @param a The base Uint16.
+   * @param b The exponent Uint16.
+   * @returns `a ** b` clamped to [0, 65535] as a Uint16.
+   */
+  pow,
+  /**
+   * Adds two Uint16 values.
+   *
+   * @param a The first Uint16.
+   * @param b The second Uint16.
+   * @returns `a + b` clamped to [0, 65535] as a Uint16.
+   */
+  add,
+  /**
+   * Subtracts one Uint16 from another.
+   *
+   * @param a The minuend Uint16.
+   * @param b The subtrahend Uint16.
+   * @returns `a - b` clamped to [0, 65535] as a Uint16 (minimum 0).
+   */
+  sub,
+  /**
+   * Multiplies two Uint16 values.
+   *
+   * @param a The first Uint16.
+   * @param b The second Uint16.
+   * @returns `a * b` clamped to [0, 65535] as a Uint16.
+   */
+  mul,
+  /**
+   * Divides one Uint16 by another using floor division.
+   *
+   * @param a The dividend Uint16.
+   * @param b The divisor Uint16.
+   * @returns `⌊a / b⌋` clamped to [0, 65535] as a Uint16.
+   */
+  div
 };
 
 export { Uint16, asUint16, isUint16 };

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

@@ -1 +1 @@
-{"version":3,"file":"uint16.mjs","sources":["../../../src/number/branded-types/uint16.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAQA,MAAM,iBAAiB,GAAG,uCAAuC;AAEjE,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,GAAG,EACH,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;AAMG;AACI,MAAM,QAAQ,GAAG;AAExB;;;;;;;AAOG;AACI,MAAM,QAAQ,GAAG;AAExB;;;;;;;;AAQG;AACI,MAAM,MAAM,GAAG;AACpB;;;;;;AAMG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;;;;;"}
+{"version":3,"file":"uint16.mjs","sources":["../../../src/number/branded-types/uint16.mts"],"sourcesContent":["import { type Uint16 as TtfImported_Uint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Uint16 = TtfImported_Uint16;\n\ntype ElementType = Uint16;\n\nconst typeNameInMessage = 'a non-negative integer less than 2^16';\n\nconst {\n  MAX_VALUE,\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: 'SafeInteger',\n  MIN_VALUE: 0,\n  MAX_VALUE: 2 ** 16 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a Uint16 (16-bit unsigned integer in the range [0,\n * 2^16)).\n *\n * @param value The value to check.\n * @returns `true` if the value is a Uint16, `false` otherwise.\n */\nexport const isUint16 = is;\n\n/**\n * Casts a number to a Uint16 type.\n *\n * @param value The value to cast.\n * @returns The value as a Uint16 type.\n * @throws {TypeError} If the value is not a non-negative integer less than\n *   2^16.\n */\nexport const asUint16 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 16-bit unsigned\n * integers.\n *\n * All operations automatically clamp results to the valid Uint16 range [0,\n * 65535]. This ensures that all arithmetic maintains the 16-bit unsigned\n * integer constraint, with negative results clamped to 0 and overflow results\n * clamped to MAX_VALUE.\n */\nexport const Uint16 = {\n  /**\n   * Type guard to check if a value is a Uint16.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a 16-bit unsigned integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a 16-bit unsigned integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a 16-bit unsigned integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two Uint16 values.\n   *\n   * @param a The first Uint16.\n   * @param b The second Uint16.\n   * @returns The minimum value as a Uint16.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two Uint16 values.\n   *\n   * @param a The first Uint16.\n   * @param b The second Uint16.\n   * @returns The maximum value as a Uint16.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the Uint16 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [0, 65535] as a Uint16.\n   */\n  clamp,\n\n  /**\n   * Generates a random Uint16 value within the valid range.\n   *\n   * @returns A random Uint16 between 0 and 65535.\n   */\n  random,\n\n  /**\n   * Raises a Uint16 to the power of another Uint16.\n   *\n   * @param a The base Uint16.\n   * @param b The exponent Uint16.\n   * @returns `a ** b` clamped to [0, 65535] as a Uint16.\n   */\n  pow,\n\n  /**\n   * Adds two Uint16 values.\n   *\n   * @param a The first Uint16.\n   * @param b The second Uint16.\n   * @returns `a + b` clamped to [0, 65535] as a Uint16.\n   */\n  add,\n\n  /**\n   * Subtracts one Uint16 from another.\n   *\n   * @param a The minuend Uint16.\n   * @param b The subtrahend Uint16.\n   * @returns `a - b` clamped to [0, 65535] as a Uint16 (minimum 0).\n   */\n  sub,\n\n  /**\n   * Multiplies two Uint16 values.\n   *\n   * @param a The first Uint16.\n   * @param b The second Uint16.\n   * @returns `a * b` clamped to [0, 65535] as a Uint16.\n   */\n  mul,\n\n  /**\n   * Divides one Uint16 by another using floor division.\n   *\n   * @param a The dividend Uint16.\n   * @param b The divisor Uint16.\n   * @returns `⌊a / b⌋` clamped to [0, 65535] as a Uint16.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Uint16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof Uint16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,uCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,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,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AASH,MAAM,QAAA,GAAW;AAUjB,MAAM,QAAA,GAAW;AAWjB,MAAM,MAAA,GAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQpB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;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;;;;"}

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

@@ -17,15 +17,15 @@ export declare const isUint32: (a: number) => a is TtfImported_Uint32;
  *   2^32.
  */
 export declare const asUint32: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
+    readonly "< 2^32": true;
     readonly "> -2^16": true;
     readonly "> -2^32": true;
     readonly ">= -2^15": true;
     readonly ">= -2^31": true;
     readonly ">=0": true;
-    readonly "< 2^32": true;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
     readonly SafeInt: true;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
@@ -126,17 +126,17 @@ export declare const Uint32: {
      * @param b - The divisor Uint32
      * @returns `⌊a / b⌋` as a Uint32, clamped to valid range
      */
-    readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>, y: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 10 | 20 | 30 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
-        readonly NaNValue: false;
-        readonly Finite: true;
-        readonly Int: true;
+    readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>, 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;
+        readonly "< 2^32": true;
         readonly "> -2^16": true;
         readonly "> -2^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
-        readonly "!=0": true;
-        readonly "< 2^32": true;
+        readonly Finite: true;
+        readonly Int: true;
+        readonly NaNValue: false;
         readonly SafeInt: true;
     } & Readonly<{
         'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;

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

@@ -1,126 +1,119 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a non-negative integer less than 2^32';
-const { MAX_VALUE, MIN_VALUE, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'SafeInteger',
-    MIN_VALUE: 0,
-    MAX_VALUE: 2 ** 32 - 1,
-    typeNameInMessage,
+const typeNameInMessage = "a non-negative integer less than 2^32";
+const {
+  MAX_VALUE,
+  MIN_VALUE,
+  add,
+  castType,
+  clamp,
+  div,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "SafeInteger",
+  MIN_VALUE: 0,
+  MAX_VALUE: 2 ** 32 - 1,
+  typeNameInMessage
 });
-/**
- * Checks if a number is a Uint32 (32-bit unsigned integer in the range [0,
- * 2^32)).
- *
- * @param value The value to check.
- * @returns `true` if the value is a Uint32, `false` otherwise.
- */
 const isUint32 = is;
-/**
- * Casts a number to a Uint32 type.
- *
- * @param value The value to cast.
- * @returns The value as a Uint32 type.
- * @throws {TypeError} If the value is not a non-negative integer less than
- *   2^32.
- */
 const asUint32 = castType;
-/**
- * Utility functions for working with Uint32 (32-bit unsigned integer) branded
- * types. Provides type-safe operations that ensure results remain within the
- * valid range [0, 2^32). All arithmetic operations are clamped to maintain the
- * Uint32 constraint.
- */
 const Uint32 = {
-    /**
-     * Type guard that checks if a value is a 32-bit unsigned integer.
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is within the range [0, 2^32), `false`
-     *   otherwise
-     */
-    is,
-    /**
-     * The minimum value for a Uint32.
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * The maximum value for a Uint32.
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the minimum of multiple Uint32 values.
-     *
-     * @param values - The Uint32 values to compare
-     * @returns The smallest value as a Uint32
-     */
-    min: min_,
-    /**
-     * Returns the maximum of multiple Uint32 values.
-     *
-     * @param values - The Uint32 values to compare
-     * @returns The largest value as a Uint32
-     */
-    max: max_,
-    /**
-     * Clamps a Uint32 to be within the specified range.
-     *
-     * @param value - The value to clamp
-     * @param min - The minimum value
-     * @param max - The maximum value
-     * @returns The clamped value as a Uint32
-     */
-    clamp,
-    /**
-     * Generates a random Uint32 value.
-     *
-     * @returns A random Uint32 value within [0, 2^32)
-     */
-    random,
-    /**
-     * Raises a Uint32 to a power, with result clamped to [0, 2^32).
-     *
-     * @param a - The base Uint32
-     * @param b - The exponent Uint32
-     * @returns `a ** b` as a Uint32, clamped to valid range
-     */
-    pow,
-    /**
-     * Adds two Uint32 values, with result clamped to [0, 2^32).
-     *
-     * @param a - First Uint32
-     * @param b - Second Uint32
-     * @returns `a + b` as a Uint32, clamped to valid range
-     */
-    add,
-    /**
-     * Subtracts two Uint32 values, with result clamped to [0, 2^32).
-     *
-     * @param a - First Uint32
-     * @param b - Second Uint32
-     * @returns `a - b` as a Uint32, clamped to valid range (minimum 0)
-     */
-    sub,
-    /**
-     * Multiplies two Uint32 values, with result clamped to [0, 2^32).
-     *
-     * @param a - First Uint32
-     * @param b - Second Uint32
-     * @returns `a * b` as a Uint32, clamped to valid range
-     */
-    mul,
-    /**
-     * Divides two Uint32 values using floor division, with result clamped to [0,
-     * 2^32).
-     *
-     * @param a - The dividend Uint32
-     * @param b - The divisor Uint32
-     * @returns `⌊a / b⌋` as a Uint32, clamped to valid range
-     */
-    div,
+  /**
+   * Type guard that checks if a value is a 32-bit unsigned integer.
+   *
+   * @param value - The value to check
+   * @returns `true` if the value is within the range [0, 2^32), `false`
+   *   otherwise
+   */
+  is,
+  /**
+   * The minimum value for a Uint32.
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * The maximum value for a Uint32.
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the minimum of multiple Uint32 values.
+   *
+   * @param values - The Uint32 values to compare
+   * @returns The smallest value as a Uint32
+   */
+  min: min_,
+  /**
+   * Returns the maximum of multiple Uint32 values.
+   *
+   * @param values - The Uint32 values to compare
+   * @returns The largest value as a Uint32
+   */
+  max: max_,
+  /**
+   * Clamps a Uint32 to be within the specified range.
+   *
+   * @param value - The value to clamp
+   * @param min - The minimum value
+   * @param max - The maximum value
+   * @returns The clamped value as a Uint32
+   */
+  clamp,
+  /**
+   * Generates a random Uint32 value.
+   *
+   * @returns A random Uint32 value within [0, 2^32)
+   */
+  random,
+  /**
+   * Raises a Uint32 to a power, with result clamped to [0, 2^32).
+   *
+   * @param a - The base Uint32
+   * @param b - The exponent Uint32
+   * @returns `a ** b` as a Uint32, clamped to valid range
+   */
+  pow,
+  /**
+   * Adds two Uint32 values, with result clamped to [0, 2^32).
+   *
+   * @param a - First Uint32
+   * @param b - Second Uint32
+   * @returns `a + b` as a Uint32, clamped to valid range
+   */
+  add,
+  /**
+   * Subtracts two Uint32 values, with result clamped to [0, 2^32).
+   *
+   * @param a - First Uint32
+   * @param b - Second Uint32
+   * @returns `a - b` as a Uint32, clamped to valid range (minimum 0)
+   */
+  sub,
+  /**
+   * Multiplies two Uint32 values, with result clamped to [0, 2^32).
+   *
+   * @param a - First Uint32
+   * @param b - Second Uint32
+   * @returns `a * b` as a Uint32, clamped to valid range
+   */
+  mul,
+  /**
+   * Divides two Uint32 values using floor division, with result clamped to [0,
+   * 2^32).
+   *
+   * @param a - The dividend Uint32
+   * @param b - The divisor Uint32
+   * @returns `⌊a / b⌋` as a Uint32, clamped to valid range
+   */
+  div
 };
 
 export { Uint32, asUint32, isUint32 };

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

@@ -1 +1 @@
-{"version":3,"file":"uint32.mjs","sources":["../../../src/number/branded-types/uint32.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAQA,MAAM,iBAAiB,GAAG,uCAAuC;AAEjE,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,GAAG,EACH,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;AAMG;AACI,MAAM,QAAQ,GAAG;AAExB;;;;;;;AAOG;AACI,MAAM,QAAQ,GAAG;AAExB;;;;;AAKG;AACI,MAAM,MAAM,GAAG;AACpB;;;;;;AAMG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;AAOG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;;AAOG;IACH,GAAG;;;;;"}
+{"version":3,"file":"uint32.mjs","sources":["../../../src/number/branded-types/uint32.mts"],"sourcesContent":["import { type Uint32 as TtfImported_Uint32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Uint32 = TtfImported_Uint32;\n\ntype ElementType = Uint32;\n\nconst typeNameInMessage = 'a non-negative integer less than 2^32';\n\nconst {\n  MAX_VALUE,\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: 'SafeInteger',\n  MIN_VALUE: 0,\n  MAX_VALUE: 2 ** 32 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a Uint32 (32-bit unsigned integer in the range [0,\n * 2^32)).\n *\n * @param value The value to check.\n * @returns `true` if the value is a Uint32, `false` otherwise.\n */\nexport const isUint32 = is;\n\n/**\n * Casts a number to a Uint32 type.\n *\n * @param value The value to cast.\n * @returns The value as a Uint32 type.\n * @throws {TypeError} If the value is not a non-negative integer less than\n *   2^32.\n */\nexport const asUint32 = castType;\n\n/**\n * Utility functions for working with Uint32 (32-bit unsigned integer) branded\n * types. Provides type-safe operations that ensure results remain within the\n * valid range [0, 2^32). All arithmetic operations are clamped to maintain the\n * Uint32 constraint.\n */\nexport const Uint32 = {\n  /**\n   * Type guard that checks if a value is a 32-bit unsigned integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is within the range [0, 2^32), `false`\n   *   otherwise\n   */\n  is,\n\n  /**\n   * The minimum value for a Uint32.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a Uint32.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the minimum of multiple Uint32 values.\n   *\n   * @param values - The Uint32 values to compare\n   * @returns The smallest value as a Uint32\n   */\n  min: min_,\n\n  /**\n   * Returns the maximum of multiple Uint32 values.\n   *\n   * @param values - The Uint32 values to compare\n   * @returns The largest value as a Uint32\n   */\n  max: max_,\n\n  /**\n   * Clamps a Uint32 to be within the specified range.\n   *\n   * @param value - The value to clamp\n   * @param min - The minimum value\n   * @param max - The maximum value\n   * @returns The clamped value as a Uint32\n   */\n  clamp,\n\n  /**\n   * Generates a random Uint32 value.\n   *\n   * @returns A random Uint32 value within [0, 2^32)\n   */\n  random,\n\n  /**\n   * Raises a Uint32 to a power, with result clamped to [0, 2^32).\n   *\n   * @param a - The base Uint32\n   * @param b - The exponent Uint32\n   * @returns `a ** b` as a Uint32, clamped to valid range\n   */\n  pow,\n\n  /**\n   * Adds two Uint32 values, with result clamped to [0, 2^32).\n   *\n   * @param a - First Uint32\n   * @param b - Second Uint32\n   * @returns `a + b` as a Uint32, clamped to valid range\n   */\n  add,\n\n  /**\n   * Subtracts two Uint32 values, with result clamped to [0, 2^32).\n   *\n   * @param a - First Uint32\n   * @param b - Second Uint32\n   * @returns `a - b` as a Uint32, clamped to valid range (minimum 0)\n   */\n  sub,\n\n  /**\n   * Multiplies two Uint32 values, with result clamped to [0, 2^32).\n   *\n   * @param a - First Uint32\n   * @param b - Second Uint32\n   * @returns `a * b` as a Uint32, clamped to valid range\n   */\n  mul,\n\n  /**\n   * Divides two Uint32 values using floor division, with result clamped to [0,\n   * 2^32).\n   *\n   * @param a - The dividend Uint32\n   * @param b - The divisor Uint32\n   * @returns `⌊a / b⌋` as a Uint32, clamped to valid range\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Uint32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof Uint32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,uCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,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,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AASH,MAAM,QAAA,GAAW;AAUjB,MAAM,QAAA,GAAW;AAQjB,MAAM,MAAA,GAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQpB,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,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUL,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;AAAA,EAUA;AACF;;;;"}