ts-data-forge 11.0.0 → 12.0.0

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

@@ -1,20 +1,24 @@
 import { type Uint16 as TtfImported_Uint16 } from 'ts-type-forge';
 export type Uint16 = TtfImported_Uint16;
 /**
- * Checks if a number is a Uint16 (16-bit unsigned integer in the range [0,
- * 2^16)).
+ * Type guard that checks if a value is a non-negative integer less than 2^16.
  *
- * @param value The value to check.
- * @returns `true` if the value is a Uint16, `false` otherwise.
+ * Returns `true` for a non-negative integer less than 2^16 — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative integer less than 2^16, `false` otherwise
  */
 export declare const isUint16: (a: number) => a is TtfImported_Uint16;
 /**
- * Casts a number to a Uint16 type.
+ * Casts a `number` to the `Uint16` branded type.
+ *
+ * Validates that the value is a non-negative integer less than 2^16 and returns
+ * it with the `Uint16` brand. Throws a `TypeError` otherwise.
  *
- * @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.
+ * @param value - The value to cast
+ * @returns The value as an `Uint16`
+ * @throws {TypeError} If the value is not a non-negative integer less than 2^16
  */
 export declare const asUint16: <N extends number>(x: N) => number & {
     readonly "< 2^16": true;
@@ -33,102 +37,105 @@ export declare const asUint16: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 16-bit unsigned
- * integers.
+ * Namespace providing type-safe operations for the `Uint16` branded type.
  *
- * 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.
+ * The `Uint16` type represents a non-negative integer less than 2^16. Division
+ * (`div`) uses floor division.
  */
 export declare const Uint16: {
     /**
-     * Type guard to check if a value is a Uint16.
+     * Type guard that checks if a value is a non-negative integer less than 2^16.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a 16-bit unsigned integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-negative integer less than 2^16, `false` otherwise
+     * @see {@link isUint16} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_Uint16;
     /**
-     * The minimum value for a 16-bit unsigned integer.
-     *
-     * @readonly
+     * The smallest value representable as `Uint16` (the lower saturation target
+     * of `fromNumber`).
      */
     readonly MIN_VALUE: 0;
     /**
-     * The maximum value for a 16-bit unsigned integer.
-     *
-     * @readonly
+     * The largest value representable as `Uint16` (the upper saturation target of
+     * `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the smaller of two Uint16 values.
+     * Returns the smallest of the given non-negative integers.
      *
-     * @param a The first Uint16.
-     * @param b The second Uint16.
-     * @returns The minimum value as a Uint16.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The smallest value as an `Uint16`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Uint16>[]) => TtfImported_Uint16;
     /**
-     * Returns the larger of two Uint16 values.
+     * Returns the largest of the given non-negative integers.
      *
-     * @param a The first Uint16.
-     * @param b The second Uint16.
-     * @returns The maximum value as a Uint16.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The largest value as an `Uint16`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Uint16>[]) => TtfImported_Uint16;
     /**
-     * Clamps a number to the Uint16 range.
+     * Converts an arbitrary `number` into an `Uint16`, rounding to the nearest
+     * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+     *
+     * Unlike `asUint16`, this is total: out-of-range inputs are clamped to the
+     * nearest representable `Uint16` instead of throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, 65535] as a Uint16.
+     * @param value - The value to convert
+     * @returns The value as an `Uint16`
      */
-    readonly clamp: (x: number) => TtfImported_Uint16;
+    readonly fromNumber: (x: number) => TtfImported_Uint16;
     /**
-     * Generates a random Uint16 value within the valid range.
+     * Generates a random `Uint16` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random Uint16 between 0 and 65535.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `Uint16` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_Uint16> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_Uint16> | undefined) => TtfImported_Uint16;
     /**
-     * Raises a Uint16 to the power of another Uint16.
+     * Raises `a` to the power `b`, returning `a ** b` as an `Uint16` (floored to
+     * an integer).
      *
-     * @param a The base Uint16.
-     * @param b The exponent Uint16.
-     * @returns `a ** b` clamped to [0, 65535] as a Uint16.
+     * @param a - The base non-negative integer
+     * @param b - The exponent non-negative integer
+     * @returns `a ** b` as an `Uint16`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>, y: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>) => TtfImported_Uint16;
     /**
-     * Adds two Uint16 values.
+     * Adds two non-negative integers, returning `a + b` as an `Uint16`.
      *
-     * @param a The first Uint16.
-     * @param b The second Uint16.
-     * @returns `a + b` clamped to [0, 65535] as a Uint16.
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The sum of `a` and `b` as an `Uint16`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>, y: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>) => TtfImported_Uint16;
     /**
-     * Subtracts one Uint16 from another.
+     * Subtracts two non-negative integers, returning `a - b` as an `Uint16`.
      *
-     * @param a The minuend Uint16.
-     * @param b The subtrahend Uint16.
-     * @returns `a - b` clamped to [0, 65535] as a Uint16 (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 `Uint16`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>, y: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>) => TtfImported_Uint16;
     /**
-     * Multiplies two Uint16 values.
+     * Multiplies two non-negative integers, returning `a * b` as an `Uint16`.
      *
-     * @param a The first Uint16.
-     * @param b The second Uint16.
-     * @returns `a * b` clamped to [0, 65535] as a Uint16.
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The product of `a` and `b` as an `Uint16`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>, y: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>) => TtfImported_Uint16;
     /**
-     * Divides one Uint16 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 `Uint16`.
      *
-     * @param a The dividend Uint16.
-     * @param b The divisor Uint16.
-     * @returns `⌊a / b⌋` clamped to [0, 65535] as a Uint16.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as an `Uint16`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint16>, 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/uint16.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"uint16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/uint16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,IAAI,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAIlE,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC;AA+BxC;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,wCAAK,CAAC;AAE3B;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;MAAW,CAAC;AAEjC;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM;IACjB;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"uint16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/uint16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,IAAI,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAIlE,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC;AA+BxC;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,wCAAK,CAAC;AAE3B;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;MAAW,CAAC;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,MAAM;IACjB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;OASG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}

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

@@ -6,8 +6,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -25,92 +25,98 @@ const isUint16 = is;
 const asUint16 = castType;
 const Uint16 = {
   /**
-   * Type guard to check if a value is a Uint16.
+   * Type guard that checks if a value is a non-negative integer less than 2^16.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 16-bit unsigned integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-negative integer less than 2^16, `false` otherwise
+   * @see {@link isUint16} for usage examples
    */
   is,
   /**
-   * The minimum value for a 16-bit unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `Uint16` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 16-bit unsigned integer.
-   *
-   * @readonly
+   * The largest value representable as `Uint16` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two Uint16 values.
+   * Returns the smallest of the given non-negative integers.
    *
-   * @param a The first Uint16.
-   * @param b The second Uint16.
-   * @returns The minimum value as a Uint16.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The smallest value as an `Uint16`
    */
   min: min_,
   /**
-   * Returns the larger of two Uint16 values.
+   * Returns the largest of the given non-negative integers.
    *
-   * @param a The first Uint16.
-   * @param b The second Uint16.
-   * @returns The maximum value as a Uint16.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The largest value as an `Uint16`
    */
   max: max_,
   /**
-   * Clamps a number to the Uint16 range.
+   * Converts an arbitrary `number` into an `Uint16`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, 65535] as a Uint16.
+   * Unlike `asUint16`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Uint16` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as an `Uint16`
    */
-  clamp,
+  fromNumber,
   /**
-   * Generates a random Uint16 value within the valid range.
+   * Generates a random `Uint16` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random Uint16 between 0 and 65535.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Uint16` in `[min, max]`
    */
   random,
   /**
-   * Raises a Uint16 to the power of another Uint16.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Uint16` (floored to
+   * an integer).
    *
-   * @param a The base Uint16.
-   * @param b The exponent Uint16.
-   * @returns `a ** b` clamped to [0, 65535] as a Uint16.
+   * @param a - The base non-negative integer
+   * @param b - The exponent non-negative integer
+   * @returns `a ** b` as an `Uint16`
    */
   pow,
   /**
-   * Adds two Uint16 values.
+   * Adds two non-negative integers, returning `a + b` as an `Uint16`.
    *
-   * @param a The first Uint16.
-   * @param b The second Uint16.
-   * @returns `a + b` clamped to [0, 65535] as a Uint16.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The sum of `a` and `b` as an `Uint16`
    */
   add,
   /**
-   * Subtracts one Uint16 from another.
+   * Subtracts two non-negative integers, returning `a - b` as an `Uint16`.
    *
-   * @param a The minuend Uint16.
-   * @param b The subtrahend Uint16.
-   * @returns `a - b` clamped to [0, 65535] as a Uint16 (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 `Uint16`
    */
   sub,
   /**
-   * Multiplies two Uint16 values.
+   * Multiplies two non-negative integers, returning `a * b` as an `Uint16`.
    *
-   * @param a The first Uint16.
-   * @param b The second Uint16.
-   * @returns `a * b` clamped to [0, 65535] as a Uint16.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The product of `a` and `b` as an `Uint16`
    */
   mul,
   /**
-   * Divides one Uint16 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 `Uint16`.
    *
-   * @param a The dividend Uint16.
-   * @param b The divisor Uint16.
-   * @returns `⌊a / b⌋` clamped to [0, 65535] as a Uint16.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Uint16`
    */
   div
 };

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

@@ -1 +1 @@
-{"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;;;;"}
+{"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  div,\n  fromNumber,\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 * Type guard that checks if a value is a non-negative integer less than 2^16.\n *\n * Returns `true` for a non-negative integer less than 2^16 — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative integer less than 2^16, `false` otherwise\n */\nexport const isUint16 = is;\n\n/**\n * Casts a `number` to the `Uint16` branded type.\n *\n * Validates that the value is a non-negative integer less than 2^16 and returns\n * it with the `Uint16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as an `Uint16`\n * @throws {TypeError} If the value is not a non-negative integer less than 2^16\n */\nexport const asUint16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `Uint16` branded type.\n *\n * The `Uint16` type represents a non-negative integer less than 2^16. Division\n * (`div`) uses floor division.\n */\nexport const Uint16 = {\n  /**\n   * Type guard that checks if a value is a non-negative integer less than 2^16.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative integer less than 2^16, `false` otherwise\n   * @see {@link isUint16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `Uint16` (the lower saturation target\n   * of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `Uint16` (the upper saturation target of\n   * `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The smallest value as an `Uint16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The largest value as an `Uint16`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into an `Uint16`, rounding to the nearest\n   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asUint16`, this is total: out-of-range inputs are clamped to the\n   * nearest representable `Uint16` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as an `Uint16`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `Uint16` 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 `Uint16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as an `Uint16` (floored to\n   * an integer).\n   *\n   * @param a - The base non-negative integer\n   * @param b - The exponent non-negative integer\n   * @returns `a ** b` as an `Uint16`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as an `Uint16`.\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 `Uint16`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as an `Uint16`.\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 `Uint16`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as an `Uint16`.\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 `Uint16`\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 `Uint16`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as an `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,GAAA;AAAA,EACA,UAAA;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;AAWH,MAAM,QAAA,GAAW;AAYjB,MAAM,QAAA,GAAW;AAQjB,MAAM,MAAA,GAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQpB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,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;AAAA;AAAA,EAYL,UAAA;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/uint32.d.mts

@@ -1,20 +1,24 @@
 import { type Uint32 as TtfImported_Uint32 } from 'ts-type-forge';
 export type Uint32 = TtfImported_Uint32;
 /**
- * Checks if a number is a Uint32 (32-bit unsigned integer in the range [0,
- * 2^32)).
+ * Type guard that checks if a value is a non-negative integer less than 2^32.
  *
- * @param value The value to check.
- * @returns `true` if the value is a Uint32, `false` otherwise.
+ * Returns `true` for a non-negative integer less than 2^32 — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative integer less than 2^32, `false` otherwise
  */
 export declare const isUint32: (a: number) => a is TtfImported_Uint32;
 /**
- * Casts a number to a Uint32 type.
+ * Casts a `number` to the `Uint32` branded type.
+ *
+ * Validates that the value is a non-negative integer less than 2^32 and returns
+ * it with the `Uint32` brand. Throws a `TypeError` otherwise.
  *
- * @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.
+ * @param value - The value to cast
+ * @returns The value as an `Uint32`
+ * @throws {TypeError} If the value is not a non-negative integer less than 2^32
  */
 export declare const asUint32: <N extends number>(x: N) => number & {
     readonly "< 2^32": true;
@@ -31,100 +35,105 @@ export declare const asUint32: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * 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.
+ * Namespace providing type-safe operations for the `Uint32` branded type.
+ *
+ * The `Uint32` type represents a non-negative integer less than 2^32. Division
+ * (`div`) uses floor division.
  */
 export declare const Uint32: {
     /**
-     * Type guard that checks if a value is a 32-bit unsigned integer.
+     * Type guard that checks if a value is a non-negative integer less than 2^32.
      *
      * @param value - The value to check
-     * @returns `true` if the value is within the range [0, 2^32), `false`
-     *   otherwise
+     * @returns `true` if the value is a non-negative integer less than 2^32, `false` otherwise
+     * @see {@link isUint32} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_Uint32;
     /**
-     * The minimum value for a Uint32.
-     *
-     * @readonly
+     * The smallest value representable as `Uint32` (the lower saturation target
+     * of `fromNumber`).
      */
     readonly MIN_VALUE: 0;
     /**
-     * The maximum value for a Uint32.
-     *
-     * @readonly
+     * The largest value representable as `Uint32` (the upper saturation target of
+     * `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the minimum of multiple Uint32 values.
+     * Returns the smallest of the given non-negative integers.
      *
-     * @param values - The Uint32 values to compare
-     * @returns The smallest value as a Uint32
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The smallest value as an `Uint32`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Uint32>[]) => TtfImported_Uint32;
     /**
-     * Returns the maximum of multiple Uint32 values.
+     * Returns the largest of the given non-negative integers.
      *
-     * @param values - The Uint32 values to compare
-     * @returns The largest value as a Uint32
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The largest value as an `Uint32`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_Uint32>[]) => TtfImported_Uint32;
     /**
-     * Clamps a Uint32 to be within the specified range.
+     * Converts an arbitrary `number` into an `Uint32`, rounding to the nearest
+     * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+     *
+     * Unlike `asUint32`, this is total: out-of-range inputs are clamped to the
+     * nearest representable `Uint32` instead of throwing.
      *
-     * @param value - The value to clamp
-     * @param min - The minimum value
-     * @param max - The maximum value
-     * @returns The clamped value as a Uint32
+     * @param value - The value to convert
+     * @returns The value as an `Uint32`
      */
-    readonly clamp: (x: number) => TtfImported_Uint32;
+    readonly fromNumber: (x: number) => TtfImported_Uint32;
     /**
-     * Generates a random Uint32 value.
+     * Generates a random `Uint32` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random Uint32 value within [0, 2^32)
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `Uint32` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_Uint32> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_Uint32> | undefined) => TtfImported_Uint32;
     /**
-     * Raises a Uint32 to a power, with result clamped to [0, 2^32).
+     * Raises `a` to the power `b`, returning `a ** b` as an `Uint32` (floored to
+     * an integer).
      *
-     * @param a - The base Uint32
-     * @param b - The exponent Uint32
-     * @returns `a ** b` as a Uint32, clamped to valid range
+     * @param a - The base non-negative integer
+     * @param b - The exponent non-negative integer
+     * @returns `a ** b` as an `Uint32`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>, y: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>) => TtfImported_Uint32;
     /**
-     * Adds two Uint32 values, with result clamped to [0, 2^32).
+     * Adds two non-negative integers, returning `a + b` as an `Uint32`.
      *
-     * @param a - First Uint32
-     * @param b - Second Uint32
-     * @returns `a + b` as a Uint32, clamped to valid range
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The sum of `a` and `b` as an `Uint32`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>, y: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>) => TtfImported_Uint32;
     /**
-     * Subtracts two Uint32 values, with result clamped to [0, 2^32).
+     * Subtracts two non-negative integers, returning `a - b` as an `Uint32`.
      *
-     * @param a - First Uint32
-     * @param b - Second Uint32
-     * @returns `a - b` as a Uint32, clamped to valid range (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 `Uint32`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>, y: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>) => TtfImported_Uint32;
     /**
-     * Multiplies two Uint32 values, with result clamped to [0, 2^32).
+     * Multiplies two non-negative integers, returning `a * b` as an `Uint32`.
      *
-     * @param a - First Uint32
-     * @param b - Second Uint32
-     * @returns `a * b` as a Uint32, clamped to valid range
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The product of `a` and `b` as an `Uint32`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>, y: import("ts-type-forge").WithSmallInt<TtfImported_Uint32>) => TtfImported_Uint32;
     /**
-     * Divides two Uint32 values using floor division, with result clamped to [0,
-     * 2^32).
+     * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+     * result is `a / b` rounded toward negative infinity, as an `Uint32`.
      *
-     * @param a - The dividend Uint32
-     * @param b - The divisor Uint32
-     * @returns `⌊a / b⌋` as a Uint32, clamped to valid range
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as an `Uint32`
      */
     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;

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

@@ -1 +1 @@
-{"version":3,"file":"uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/uint32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,IAAI,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAIlE,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC;AA+BxC;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,wCAAK,CAAC;AAE3B;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;MAAW,CAAC;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,MAAM;IACjB;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;OAOG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/uint32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,IAAI,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAIlE,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC;AA+BxC;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,wCAAK,CAAC;AAE3B;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;MAAW,CAAC;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,MAAM;IACjB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;OASG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;CAEK,CAAC"}