ts-data-forge 11.0.0 → 11.0.1

package/dist/number/enum/uint8.d.mts

@@ -1,119 +1,121 @@
 import { type Uint8 as TtfImported_Uint8 } from 'ts-type-forge';
 export type Uint8 = TtfImported_Uint8;
 /**
- * Checks if a number is a Uint8 (8-bit unsigned integer in the range [0, 255]).
+ * Type guard that checks if a value is an non-negative integer less than 256.
  *
- * @param value The value to check.
- * @returns `true` if the value is a Uint8, `false` otherwise.
+ * Returns `true` for an non-negative integer less than 256 — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is an non-negative integer less than 256, `false` otherwise
  */
 export declare const isUint8: (x: number) => x is Uint8;
 /**
- * Casts a number to a Uint8 type. This function validates that the input is
- * within the Uint8 range [0, 255] and is an integer, then returns it with the
- * Uint8 brand.
+ * Casts a `number` to the `Uint8` branded type.
+ *
+ * Validates that the value is an non-negative integer less than 256 and returns
+ * it with the `Uint8` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a Uint8 type.
- * @throws {TypeError} If the value is not a valid 8-bit unsigned integer.
+ * @param value - The value to cast
+ * @returns The value as an `Uint8`
+ * @throws {TypeError} If the value is not an non-negative integer less than 256
  */
 export declare const asUint8: (x: number) => Uint8;
 /**
- * Namespace providing type-safe arithmetic operations for 8-bit unsigned
- * integers.
+ * Namespace providing type-safe operations for the `Uint8` branded type.
  *
- * All operations automatically clamp results to the valid Uint8 range [0, 255].
- * This ensures that all arithmetic maintains the 8-bit unsigned integer
- * constraint, with negative results clamped to 0 and overflow results clamped
- * to MAX_VALUE.
+ * The `Uint8` type represents an non-negative integer less than 256. Division
+ * (`div`) uses floor division.
  */
 export declare const Uint8: {
     /**
-     * Type guard that checks if a value is an 8-bit unsigned integer.
+     * Type guard that checks if a value is an non-negative integer less than 256.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is an 8-bit unsigned integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is an non-negative integer less than 256, `false` otherwise
+     * @see {@link isUint8} for usage examples
      */
     readonly is: (x: number) => x is Uint8;
     /**
-     * The minimum value for an 8-bit unsigned integer.
-     *
-     * @readonly
+     * The smallest value representable as `Uint8`.
      */
     readonly MIN_VALUE: 0;
     /**
-     * The maximum value for an 8-bit unsigned integer.
-     *
-     * @readonly
+     * The largest value representable as `Uint8`.
      */
     readonly MAX_VALUE: 255;
     /**
-     * Returns the larger of the given Uint8 values.
+     * Returns the largest of the given non-negative integers.
      *
-     * @param values The Uint8 values to compare.
-     * @returns The maximum value as a Uint8.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The largest value as an `Uint8`
      */
     readonly max: (...values: readonly Uint8[]) => Uint8;
     /**
-     * Returns the smaller of the given Uint8 values.
+     * Returns the smallest of the given non-negative integers.
      *
-     * @param values The Uint8 values to compare.
-     * @returns The minimum value as a Uint8.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The smallest value as an `Uint8`
      */
     readonly min: (...values: readonly Uint8[]) => Uint8;
     /**
-     * Clamps a number to the Uint8 range.
+     * Clamps a `number` into the `Uint8` range, rounding to the nearest integer
+     * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, 255] as a Uint8.
+     * @param value - The value to clamp
+     * @returns The clamped value as an `Uint8`
      */
     readonly clamp: (a: number) => Uint8;
     /**
-     * Generates a random Uint8 value within the specified range.
+     * Generates a random `Uint8` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @param min The minimum value (inclusive).
-     * @param max The maximum value (inclusive).
-     * @returns A random Uint8 between min and max.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `Uint8` in `[min, max]`
      */
     readonly random: (min: Uint8, max: Uint8) => Uint8;
     /**
-     * Raises x to the power of y, clamped to Uint8 range.
+     * Raises `a` to the power `b`, returning `a ** b` as an `Uint8` (floored to
+     * an integer).
      *
-     * @param x - The base
-     * @param y - The exponent
-     * @returns `x ** y` clamped to [0, 255]
+     * @param a - The base non-negative integer
+     * @param b - The exponent non-negative integer
+     * @returns `a ** b` as an `Uint8`
      */
     readonly pow: (x: Uint8, y: Uint8) => Uint8;
     /**
-     * Adds two Uint8 values, clamped to Uint8 range.
+     * Adds two non-negative integers, returning `a + b` as an `Uint8`.
      *
-     * @param x - First operand
-     * @param y - Second operand
-     * @returns `x + y` clamped to [0, 255]
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The sum of `a` and `b` as an `Uint8`
      */
     readonly add: (x: Uint8, y: Uint8) => Uint8;
     /**
-     * Subtracts two Uint8 values, clamped to Uint8 range.
+     * Subtracts two non-negative integers, returning `a - b` as an `Uint8`.
      *
-     * @param x - First operand
-     * @param y - Second operand
-     * @returns `x - y` clamped to [0, 255]
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The difference of `a` and `b` as an `Uint8`
      */
     readonly sub: (x: Uint8, y: Uint8) => Uint8;
     /**
-     * Multiplies two Uint8 values, clamped to Uint8 range.
+     * Multiplies two non-negative integers, returning `a * b` as an `Uint8`.
      *
-     * @param x - First operand
-     * @param y - Second operand
-     * @returns `x * y` clamped to [0, 255]
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The product of `a` and `b` as an `Uint8`
      */
     readonly mul: (x: Uint8, y: Uint8) => Uint8;
     /**
-     * Divides two Uint8 values, clamped to Uint8 range.
+     * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+     * result is `a / b` rounded toward negative infinity, as an `Uint8`.
      *
-     * @param x - The dividend
-     * @param y - The divisor (cannot be 0)
-     * @returns `⌊x / y⌋` clamped to [0, 255]
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as an `Uint8`
      */
     readonly div: (x: Uint8, y: Exclude<Uint8, 0>) => Uint8;
 };

package/dist/number/enum/uint8.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"uint8.d.mts","sourceRoot":"","sources":["../../../src/number/enum/uint8.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,IAAI,iBAAiB,EAAe,MAAM,eAAe,CAAC;AAI7E,MAAM,MAAM,KAAK,GAAG,iBAAiB,CAAC;AA+CtC;;;;;GAKG;AACH,eAAO,MAAM,OAAO,MAjCL,MAAM,KAAG,CAAC,IAAI,KAiCJ,CAAC;AAE1B;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,MA1CC,MAAM,KAAG,KA0CC,CAAC;AAEhC;;;;;;;;GAQG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;OAMG;qBA9DU,MAAM,KAAG,CAAC,IAAI,KAAK;IAiEhC;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;8BAzEoB,SAAS,KAAK,EAAE,KAAG,KAAK;IA4E/C;;;;;OAKG;8BApFoB,SAAS,KAAK,EAAE,KAAG,KAAK;IAuF/C;;;;;OAKG;wBA9Fa,MAAM,KAAG,KAAK;IAiG9B;;;;;;OAMG;2BArFgB,KAAK,OAAO,KAAK,KAAG,KAAK;IAwF5C;;;;;;OAMG;sBAxGW,KAAK,KAAK,KAAK,KAAG,KAAK;IA2GrC;;;;;;OAMG;sBA/GW,KAAK,KAAK,KAAK,KAAG,KAAK;IAkHrC;;;;;;OAMG;sBAtHW,KAAK,KAAK,KAAK,KAAG,KAAK;IAyHrC;;;;;;OAMG;sBA7HW,KAAK,KAAK,KAAK,KAAG,KAAK;IAgIrC;;;;;;OAMG;sBApIW,KAAK,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,KAAG,KAAK;CAsIzC,CAAC"}
+{"version":3,"file":"uint8.d.mts","sourceRoot":"","sources":["../../../src/number/enum/uint8.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,IAAI,iBAAiB,EAAe,MAAM,eAAe,CAAC;AAI7E,MAAM,MAAM,KAAK,GAAG,iBAAiB,CAAC;AA+CtC;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,MApCL,MAAM,KAAG,CAAC,IAAI,KAoCJ,CAAC;AAE1B;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,MA9CC,MAAM,KAAG,KA8CC,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;OAMG;qBA/DU,MAAM,KAAG,CAAC,IAAI,KAAK;IAkEhC;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;8BAtEoB,SAAS,KAAK,EAAE,KAAG,KAAK;IAyE/C;;;;;OAKG;8BAjFoB,SAAS,KAAK,EAAE,KAAG,KAAK;IAoF/C;;;;;;OAMG;wBA5Fa,MAAM,KAAG,KAAK;IA+F9B;;;;;;;;OAQG;2BArFgB,KAAK,OAAO,KAAK,KAAG,KAAK;IAwF5C;;;;;;;OAOG;sBAzGW,KAAK,KAAK,KAAK,KAAG,KAAK;IA4GrC;;;;;;OAMG;sBAhHW,KAAK,KAAK,KAAK,KAAG,KAAK;IAmHrC;;;;;;OAMG;sBAvHW,KAAK,KAAK,KAAK,KAAG,KAAK;IA0HrC;;;;;;OAMG;sBA9HW,KAAK,KAAK,KAAK,KAAG,KAAK;IAiIrC;;;;;;;OAOG;sBAtIW,KAAK,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,KAAG,KAAK;CAwIzC,CAAC"}

package/dist/number/enum/uint8.mjs

@@ -34,92 +34,93 @@ const isUint8 = is;
 const asUint8 = castType;
 const Uint8 = {
   /**
-   * Type guard that checks if a value is an 8-bit unsigned integer.
+   * Type guard that checks if a value is an non-negative integer less than 256.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is an 8-bit unsigned integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is an non-negative integer less than 256, `false` otherwise
+   * @see {@link isUint8} for usage examples
    */
   is,
   /**
-   * The minimum value for an 8-bit unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `Uint8`.
    */
   MIN_VALUE,
   /**
-   * The maximum value for an 8-bit unsigned integer.
-   *
-   * @readonly
+   * The largest value representable as `Uint8`.
    */
   MAX_VALUE,
   /**
-   * Returns the larger of the given Uint8 values.
+   * Returns the largest of the given non-negative integers.
    *
-   * @param values The Uint8 values to compare.
-   * @returns The maximum value as a Uint8.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The largest value as an `Uint8`
    */
   max: max_,
   /**
-   * Returns the smaller of the given Uint8 values.
+   * Returns the smallest of the given non-negative integers.
    *
-   * @param values The Uint8 values to compare.
-   * @returns The minimum value as a Uint8.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The smallest value as an `Uint8`
    */
   min: min_,
   /**
-   * Clamps a number to the Uint8 range.
+   * Clamps a `number` into the `Uint8` range, rounding to the nearest integer
+   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, 255] as a Uint8.
+   * @param value - The value to clamp
+   * @returns The clamped value as an `Uint8`
    */
   clamp,
   /**
-   * Generates a random Uint8 value within the specified range.
+   * Generates a random `Uint8` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @param min The minimum value (inclusive).
-   * @param max The maximum value (inclusive).
-   * @returns A random Uint8 between min and max.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Uint8` in `[min, max]`
    */
   random,
   /**
-   * Raises x to the power of y, clamped to Uint8 range.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Uint8` (floored to
+   * an integer).
    *
-   * @param x - The base
-   * @param y - The exponent
-   * @returns `x ** y` clamped to [0, 255]
+   * @param a - The base non-negative integer
+   * @param b - The exponent non-negative integer
+   * @returns `a ** b` as an `Uint8`
    */
   pow,
   /**
-   * Adds two Uint8 values, clamped to Uint8 range.
+   * Adds two non-negative integers, returning `a + b` as an `Uint8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x + y` clamped to [0, 255]
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The sum of `a` and `b` as an `Uint8`
    */
   add,
   /**
-   * Subtracts two Uint8 values, clamped to Uint8 range.
+   * Subtracts two non-negative integers, returning `a - b` as an `Uint8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x - y` clamped to [0, 255]
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The difference of `a` and `b` as an `Uint8`
    */
   sub,
   /**
-   * Multiplies two Uint8 values, clamped to Uint8 range.
+   * Multiplies two non-negative integers, returning `a * b` as an `Uint8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x * y` clamped to [0, 255]
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The product of `a` and `b` as an `Uint8`
    */
   mul,
   /**
-   * Divides two Uint8 values, clamped to Uint8 range.
+   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as an `Uint8`.
    *
-   * @param x - The dividend
-   * @param y - The divisor (cannot be 0)
-   * @returns `⌊x / y⌋` clamped to [0, 255]
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Uint8`
    */
   div
 };

package/dist/number/enum/uint8.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"uint8.mjs","sources":["../../../src/number/enum/uint8.mts"],"sourcesContent":["import { type Uint8 as TtfImported_Uint8, type Uint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Uint8 = TtfImported_Uint8;\n\nconst typeNameInMessage = 'an non-negative integer less than 256';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  castType: castTypeImpl,\n  clamp: clampImpl,\n  is: isImpl,\n  random: randomImpl,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<Uint16, 0, 255>(\n  {\n    integerOrSafeInteger: 'SafeInteger',\n    MIN_VALUE: 0,\n    MAX_VALUE: 255,\n    typeNameInMessage,\n  } as const,\n);\n\nconst is = (x: number): x is Uint8 => isImpl(x);\n\nconst castType = (x: number): Uint8 =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  castTypeImpl(x) as Uint8;\n\nconst clamp = (a: number): Uint8 => castType(clampImpl(a));\n\nconst min_ = (...values: readonly Uint8[]): Uint8 =>\n  castType(Math.min(...values));\n\nconst max_ = (...values: readonly Uint8[]): Uint8 =>\n  castType(Math.max(...values));\n\nconst pow = (x: Uint8, y: Uint8): Uint8 => clamp(x ** y);\n\nconst add = (x: Uint8, y: Uint8): Uint8 => clamp(x + y);\n\nconst sub = (x: Uint8, y: Uint8): Uint8 => clamp(x - y);\n\nconst mul = (x: Uint8, y: Uint8): Uint8 => clamp(x * y);\n\nconst div = (x: Uint8, y: Exclude<Uint8, 0>): Uint8 => clamp(Math.floor(x / y));\n\nconst random = (min: Uint8, max: Uint8): Uint8 =>\n  castType(randomImpl(castTypeImpl(min), castTypeImpl(max)));\n\n/**\n * Checks if a number is a Uint8 (8-bit unsigned integer in the range [0, 255]).\n *\n * @param value The value to check.\n * @returns `true` if the value is a Uint8, `false` otherwise.\n */\nexport const isUint8 = is;\n\n/**\n * Casts a number to a Uint8 type. This function validates that the input is\n * within the Uint8 range [0, 255] and is an integer, then returns it with the\n * Uint8 brand.\n *\n * @param value The value to cast.\n * @returns The value as a Uint8 type.\n * @throws {TypeError} If the value is not a valid 8-bit unsigned integer.\n */\nexport const asUint8 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 8-bit unsigned\n * integers.\n *\n * All operations automatically clamp results to the valid Uint8 range [0, 255].\n * This ensures that all arithmetic maintains the 8-bit unsigned integer\n * constraint, with negative results clamped to 0 and overflow results clamped\n * to MAX_VALUE.\n */\nexport const Uint8 = {\n  /**\n   * Type guard that checks if a value is an 8-bit unsigned integer.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is an 8-bit unsigned integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for an 8-bit unsigned integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for an 8-bit unsigned integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the larger of the given Uint8 values.\n   *\n   * @param values The Uint8 values to compare.\n   * @returns The maximum value as a Uint8.\n   */\n  max: max_,\n\n  /**\n   * Returns the smaller of the given Uint8 values.\n   *\n   * @param values The Uint8 values to compare.\n   * @returns The minimum value as a Uint8.\n   */\n  min: min_,\n\n  /**\n   * Clamps a number to the Uint8 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [0, 255] as a Uint8.\n   */\n  clamp,\n\n  /**\n   * Generates a random Uint8 value within the specified range.\n   *\n   * @param min The minimum value (inclusive).\n   * @param max The maximum value (inclusive).\n   * @returns A random Uint8 between min and max.\n   */\n  random,\n\n  /**\n   * Raises x to the power of y, clamped to Uint8 range.\n   *\n   * @param x - The base\n   * @param y - The exponent\n   * @returns `x ** y` clamped to [0, 255]\n   */\n  pow,\n\n  /**\n   * Adds two Uint8 values, clamped to Uint8 range.\n   *\n   * @param x - First operand\n   * @param y - Second operand\n   * @returns `x + y` clamped to [0, 255]\n   */\n  add,\n\n  /**\n   * Subtracts two Uint8 values, clamped to Uint8 range.\n   *\n   * @param x - First operand\n   * @param y - Second operand\n   * @returns `x - y` clamped to [0, 255]\n   */\n  sub,\n\n  /**\n   * Multiplies two Uint8 values, clamped to Uint8 range.\n   *\n   * @param x - First operand\n   * @param y - Second operand\n   * @returns `x * y` clamped to [0, 255]\n   */\n  mul,\n\n  /**\n   * Divides two Uint8 values, clamped to Uint8 range.\n   *\n   * @param x - The dividend\n   * @param y - The divisor (cannot be 0)\n   * @returns `⌊x / y⌋` clamped to [0, 255]\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Uint8,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    Uint16,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n"],"names":[],"mappings":";;AAMA,MAAM,iBAAA,GAAoB,uCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,QAAA,EAAU,YAAA;AAAA,EACV,KAAA,EAAO,SAAA;AAAA,EACP,EAAA,EAAI,MAAA;AAAA,EACJ,MAAA,EAAQ;AACV,CAAA,GAAI,qBAAqB,kBAAA,CAAmB,mBAAA;AAAA,EAC1C;AAAA,IACE,oBAAA,EAAsB,aAAA;AAAA,IACtB,SAAA,EAAW,CAAA;AAAA,IACX,SAAA,EAAW,GAAA;AAAA,IACX;AAAA;AAEJ,CAAA;AAEA,MAAM,EAAA,GAAK,CAAC,CAAA,KAA0B,MAAA,CAAO,CAAC,CAAA;AAE9C,MAAM,WAAW,CAAC,CAAA;AAAA;AAAA,EAEhB,aAAa,CAAC;AAAA,CAAA;AAEhB,MAAM,QAAQ,CAAC,CAAA,KAAqB,QAAA,CAAS,SAAA,CAAU,CAAC,CAAC,CAAA;AAEzD,MAAM,IAAA,GAAO,IAAI,MAAA,KACf,QAAA,CAAS,KAAK,GAAA,CAAI,GAAG,MAAM,CAAC,CAAA;AAE9B,MAAM,IAAA,GAAO,IAAI,MAAA,KACf,QAAA,CAAS,KAAK,GAAA,CAAI,GAAG,MAAM,CAAC,CAAA;AAE9B,MAAM,MAAM,CAAC,CAAA,EAAU,CAAA,KAAoB,KAAA,CAAM,KAAK,CAAC,CAAA;AAEvD,MAAM,MAAM,CAAC,CAAA,EAAU,CAAA,KAAoB,KAAA,CAAM,IAAI,CAAC,CAAA;AAEtD,MAAM,MAAM,CAAC,CAAA,EAAU,CAAA,KAAoB,KAAA,CAAM,IAAI,CAAC,CAAA;AAEtD,MAAM,MAAM,CAAC,CAAA,EAAU,CAAA,KAAoB,KAAA,CAAM,IAAI,CAAC,CAAA;AAEtD,MAAM,GAAA,GAAM,CAAC,CAAA,EAAU,CAAA,KAAgC,MAAM,IAAA,CAAK,KAAA,CAAM,CAAA,GAAI,CAAC,CAAC,CAAA;AAE9E,MAAM,MAAA,GAAS,CAAC,GAAA,EAAY,GAAA,KAC1B,QAAA,CAAS,UAAA,CAAW,YAAA,CAAa,GAAG,CAAA,EAAG,YAAA,CAAa,GAAG,CAAC,CAAC,CAAA;AAQpD,MAAM,OAAA,GAAU;AAWhB,MAAM,OAAA,GAAU;AAWhB,MAAM,KAAA,GAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,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,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,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":"uint8.mjs","sources":["../../../src/number/enum/uint8.mts"],"sourcesContent":["import { type Uint8 as TtfImported_Uint8, type Uint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Uint8 = TtfImported_Uint8;\n\nconst typeNameInMessage = 'an non-negative integer less than 256';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  castType: castTypeImpl,\n  clamp: clampImpl,\n  is: isImpl,\n  random: randomImpl,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<Uint16, 0, 255>(\n  {\n    integerOrSafeInteger: 'SafeInteger',\n    MIN_VALUE: 0,\n    MAX_VALUE: 255,\n    typeNameInMessage,\n  } as const,\n);\n\nconst is = (x: number): x is Uint8 => isImpl(x);\n\nconst castType = (x: number): Uint8 =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  castTypeImpl(x) as Uint8;\n\nconst clamp = (a: number): Uint8 => castType(clampImpl(a));\n\nconst min_ = (...values: readonly Uint8[]): Uint8 =>\n  castType(Math.min(...values));\n\nconst max_ = (...values: readonly Uint8[]): Uint8 =>\n  castType(Math.max(...values));\n\nconst pow = (x: Uint8, y: Uint8): Uint8 => clamp(x ** y);\n\nconst add = (x: Uint8, y: Uint8): Uint8 => clamp(x + y);\n\nconst sub = (x: Uint8, y: Uint8): Uint8 => clamp(x - y);\n\nconst mul = (x: Uint8, y: Uint8): Uint8 => clamp(x * y);\n\nconst div = (x: Uint8, y: Exclude<Uint8, 0>): Uint8 => clamp(Math.floor(x / y));\n\nconst random = (min: Uint8, max: Uint8): Uint8 =>\n  castType(randomImpl(castTypeImpl(min), castTypeImpl(max)));\n\n/**\n * Type guard that checks if a value is an non-negative integer less than 256.\n *\n * Returns `true` for an non-negative integer less than 256 — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is an non-negative integer less than 256, `false` otherwise\n */\nexport const isUint8 = is;\n\n/**\n * Casts a `number` to the `Uint8` branded type.\n *\n * Validates that the value is an non-negative integer less than 256 and returns\n * it with the `Uint8` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as an `Uint8`\n * @throws {TypeError} If the value is not an non-negative integer less than 256\n */\nexport const asUint8 = castType;\n\n/**\n * Namespace providing type-safe operations for the `Uint8` branded type.\n *\n * The `Uint8` type represents an non-negative integer less than 256. Division\n * (`div`) uses floor division.\n */\nexport const Uint8 = {\n  /**\n   * Type guard that checks if a value is an non-negative integer less than 256.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is an non-negative integer less than 256, `false` otherwise\n   * @see {@link isUint8} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `Uint8`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `Uint8`.\n   */\n  MAX_VALUE,\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 `Uint8`\n   */\n  max: max_,\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 `Uint8`\n   */\n  min: min_,\n\n  /**\n   * Clamps a `number` into the `Uint8` range, rounding to the nearest integer\n   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as an `Uint8`\n   */\n  clamp,\n\n  /**\n   * Generates a random `Uint8` 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 `Uint8` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as an `Uint8` (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 `Uint8`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as an `Uint8`.\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 `Uint8`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as an `Uint8`.\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 `Uint8`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as an `Uint8`.\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 `Uint8`\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 `Uint8`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as an `Uint8`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Uint8,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    Uint16,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n"],"names":[],"mappings":";;AAMA,MAAM,iBAAA,GAAoB,uCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,QAAA,EAAU,YAAA;AAAA,EACV,KAAA,EAAO,SAAA;AAAA,EACP,EAAA,EAAI,MAAA;AAAA,EACJ,MAAA,EAAQ;AACV,CAAA,GAAI,qBAAqB,kBAAA,CAAmB,mBAAA;AAAA,EAC1C;AAAA,IACE,oBAAA,EAAsB,aAAA;AAAA,IACtB,SAAA,EAAW,CAAA;AAAA,IACX,SAAA,EAAW,GAAA;AAAA,IACX;AAAA;AAEJ,CAAA;AAEA,MAAM,EAAA,GAAK,CAAC,CAAA,KAA0B,MAAA,CAAO,CAAC,CAAA;AAE9C,MAAM,WAAW,CAAC,CAAA;AAAA;AAAA,EAEhB,aAAa,CAAC;AAAA,CAAA;AAEhB,MAAM,QAAQ,CAAC,CAAA,KAAqB,QAAA,CAAS,SAAA,CAAU,CAAC,CAAC,CAAA;AAEzD,MAAM,IAAA,GAAO,IAAI,MAAA,KACf,QAAA,CAAS,KAAK,GAAA,CAAI,GAAG,MAAM,CAAC,CAAA;AAE9B,MAAM,IAAA,GAAO,IAAI,MAAA,KACf,QAAA,CAAS,KAAK,GAAA,CAAI,GAAG,MAAM,CAAC,CAAA;AAE9B,MAAM,MAAM,CAAC,CAAA,EAAU,CAAA,KAAoB,KAAA,CAAM,KAAK,CAAC,CAAA;AAEvD,MAAM,MAAM,CAAC,CAAA,EAAU,CAAA,KAAoB,KAAA,CAAM,IAAI,CAAC,CAAA;AAEtD,MAAM,MAAM,CAAC,CAAA,EAAU,CAAA,KAAoB,KAAA,CAAM,IAAI,CAAC,CAAA;AAEtD,MAAM,MAAM,CAAC,CAAA,EAAU,CAAA,KAAoB,KAAA,CAAM,IAAI,CAAC,CAAA;AAEtD,MAAM,GAAA,GAAM,CAAC,CAAA,EAAU,CAAA,KAAgC,MAAM,IAAA,CAAK,KAAA,CAAM,CAAA,GAAI,CAAC,CAAC,CAAA;AAE9E,MAAM,MAAA,GAAS,CAAC,GAAA,EAAY,GAAA,KAC1B,QAAA,CAAS,UAAA,CAAW,YAAA,CAAa,GAAG,CAAA,EAAG,YAAA,CAAa,GAAG,CAAC,CAAC,CAAA;AAWpD,MAAM,OAAA,GAAU;AAYhB,MAAM,OAAA,GAAU;AAQhB,MAAM,KAAA,GAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-data-forge",
-  "version": "11.0.0",
+  "version": "11.0.1",
   "private": false,
   "keywords": [
     "typescript",
@@ -67,6 +67,7 @@
     "fmt": "format-uncommitted --cwd .",
     "fmt:diff": "format-diff-from origin/main --cwd .",
     "fmt:full": "pnpm run z:prettier .",
+    "gen:branded-number": "tsx ./scripts/gen-branded-number/generate.mts && pnpm run doc:embed:jsdoc && pnpm run z:prettier 'src/number/branded-types/*.mts' 'src/number/enum/*.mts'",
     "gi": "run-s gi:src fmt",
     "gi:src": "tsx scripts/cmd/gen-index.mts",
     "lint": "eslint .",

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

@@ -59,47 +59,37 @@ expectType<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Int>(
 /**
  * Type guard that checks if a value is a finite number.
  *
- * Returns `true` if the value is a finite number (not NaN, Infinity, or
- * -Infinity). This is stricter than the standard number type, which includes
- * these special values.
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
  *
  * @param value - The value to check
- * @returns `true` if the value is finite, `false` otherwise
+ * @returns `true` if the value is a finite number, `false` otherwise
  */
 export const isFiniteNumber = is;
 
 /**
- * Casts a number to a FiniteNumber branded type.
+ * Casts a `number` to the `FiniteNumber` branded type.
  *
- * This function validates that the input is finite (not NaN, Infinity, or
- * -Infinity) and returns it with the FiniteNumber brand. This ensures type
- * safety for operations that require finite numeric values.
+ * Validates that the value is a finite number and returns it with the
+ * `FiniteNumber` brand. Throws a `TypeError` otherwise.
  *
  * @param value - The value to cast
- * @returns The value as a FiniteNumber branded type
- * @throws {TypeError} If the value is NaN, Infinity, or -Infinity
+ * @returns The value as a `FiniteNumber`
+ * @throws {TypeError} If the value is not a finite number
  */
 export const asFiniteNumber = castType;
 
 /**
- * Namespace providing type-safe operations for FiniteNumber branded types.
+ * Namespace providing type-safe operations for the `FiniteNumber` branded type.
  *
- * The FiniteNumber type represents any finite numeric value, excluding the
- * special values NaN, Infinity, and -Infinity. All operations are guaranteed to
- * maintain the finite constraint when given finite inputs.
- *
- * This type is essential for:
- *
- * - Mathematical operations that require real numbers
- * - Preventing NaN/Infinity propagation in calculations
- * - Ensuring numeric stability in algorithms
+ * The `FiniteNumber` type represents a finite number.
  */
 export const FiniteNumber = {
   /**
    * Type guard that checks if a value is a finite number.
    *
    * @param value - The value to check
-   * @returns `true` if the value is finite, `false` otherwise
+   * @returns `true` if the value is a finite number, `false` otherwise
    * @see {@link isFiniteNumber} for usage examples
    */
   is,
@@ -107,110 +97,106 @@ export const FiniteNumber = {
   /**
    * Returns the absolute value of a finite number.
    *
-   * @param x - The finite number to get the absolute value of
-   * @returns The absolute value as a FiniteNumber
+   * The result is non-negative and keeps the `FiniteNumber` brand.
+   *
+   * @param a - The finite number value
+   * @returns The absolute value as a non-negative `FiniteNumber`
    */
   abs,
 
   /**
-   * Returns the minimum value from a list of finite numbers.
+   * Returns the smallest of the given finite numbers.
    *
    * @param values - The finite numbers to compare (at least one required)
-   * @returns The smallest value as a FiniteNumber
+   * @returns The smallest value as a `FiniteNumber`
    */
   min: min_,
 
   /**
-   * Returns the maximum value from a list of finite numbers.
+   * Returns the largest of the given finite numbers.
    *
    * @param values - The finite numbers to compare (at least one required)
-   * @returns The largest value as a FiniteNumber
+   * @returns The largest value as a `FiniteNumber`
    */
   max: max_,
 
   /**
-   * Returns the largest integer less than or equal to the given finite number.
+   * Returns the greatest integer less than or equal to a finite number.
    *
-   * @param x - The finite number to floor
-   * @returns The floor value as an Int
+   * @param a - The finite number value
+   * @returns The floored value as an integer
    */
   floor,
 
   /**
-   * Returns the smallest integer greater than or equal to the given finite
-   * number.
+   * Returns the smallest integer greater than or equal to a finite number.
    *
-   * @param x - The finite number to ceil
-   * @returns The ceiling value as an Int
+   * @param a - The finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
 
   /**
-   * Rounds a finite number to the nearest integer.
+   * Returns the value of a finite number rounded to the nearest integer.
    *
-   * @param x - The finite number to round
-   * @returns The rounded value as an Int
+   * @param a - The finite number value
+   * @returns The rounded value as an integer
    */
   round,
 
   /**
-   * Generates a random finite number within the specified range.
+   * Generates a random `FiniteNumber` within the given range.
    *
-   * The generated value is uniformly distributed in the range [min, max]. Both
-   * bounds are inclusive.
+   * The range is inclusive on both ends.
    *
    * @param min - The minimum value (inclusive)
    * @param max - The maximum value (inclusive)
-   * @returns A random FiniteNumber in the range [min, max]
+   * @returns A random `FiniteNumber` in `[min, max]`
    */
   random,
 
   /**
-   * Raises a finite number to a power.
+   * Raises `a` to the power `b`, returning `a ** b` as a `FiniteNumber`.
    *
    * @param a - The base finite number
    * @param b - The exponent finite number
-   * @returns `a ** b` as a FiniteNumber
+   * @returns `a ** b` as a `FiniteNumber`
    */
   pow,
 
   /**
-   * Adds two finite numbers.
+   * Adds two finite numbers, returning `a + b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a + b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The sum of `a` and `b` as a `FiniteNumber`
    */
   add,
 
   /**
-   * Subtracts two finite numbers.
+   * Subtracts two finite numbers, returning `a - b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a - b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The difference of `a` and `b` as a `FiniteNumber`
    */
   sub,
 
   /**
-   * Multiplies two finite numbers.
+   * Multiplies two finite numbers, returning `a * b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a * b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The product of `a` and `b` as a `FiniteNumber`
    */
   mul,
 
   /**
-   * Divides two finite numbers.
-   *
-   * The divisor must be non-zero (enforced by type constraints). The result is
-   * guaranteed to be finite when both inputs are finite and the divisor is
-   * non-zero.
+   * Divides two finite numbers, returning `a / b` as a `FiniteNumber`.
    *
    * @param a - The dividend
    * @param b - The divisor (must be non-zero)
-   * @returns The quotient `a / b` as a FiniteNumber
+   * @returns `a / b` as a `FiniteNumber`
    */
   div,
 } as const;