ts-data-forge 11.0.0 → 12.0.0

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

@@ -6,8 +6,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -25,93 +25,98 @@ const isUint32 = is;
 const asUint32 = castType;
 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
    */
   is,
   /**
-   * The minimum value for a Uint32.
-   *
-   * @readonly
+   * The smallest value representable as `Uint32` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum value for a Uint32.
-   *
-   * @readonly
+   * The largest value representable as `Uint32` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * 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`
    */
   min: min_,
   /**
-   * 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`
    */
   max: max_,
   /**
-   * 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]`.
    *
-   * @param value - The value to clamp
-   * @param min - The minimum value
-   * @param max - The maximum value
-   * @returns The clamped value as a Uint32
+   * Unlike `asUint32`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Uint32` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as an `Uint32`
    */
-  clamp,
+  fromNumber,
   /**
-   * 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]`
    */
   random,
   /**
-   * 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`
    */
   pow,
   /**
-   * 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`
    */
   add,
   /**
-   * 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`
    */
   sub,
   /**
-   * 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`
    */
   mul,
   /**
-   * 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`
    */
   div
 };

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

@@ -1 +1 @@
-{"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;;;;"}
+{"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  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 ** 32 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative integer less than 2^32.\n *\n * Returns `true` for a non-negative integer less than 2^32 — 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^32, `false` otherwise\n */\nexport const isUint32 = is;\n\n/**\n * Casts a `number` to the `Uint32` branded type.\n *\n * Validates that the value is a non-negative integer less than 2^32 and returns\n * it with the `Uint32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as an `Uint32`\n * @throws {TypeError} If the value is not a non-negative integer less than 2^32\n */\nexport const asUint32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `Uint32` branded type.\n *\n * The `Uint32` type represents a non-negative integer less than 2^32. Division\n * (`div`) uses floor division.\n */\nexport const Uint32 = {\n  /**\n   * Type guard that checks if a value is a non-negative integer less than 2^32.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative integer less than 2^32, `false` otherwise\n   * @see {@link isUint32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `Uint32` (the lower saturation target\n   * of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `Uint32` (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 `Uint32`\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 `Uint32`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into an `Uint32`, rounding to the nearest\n   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asUint32`, this is total: out-of-range inputs are clamped to the\n   * nearest representable `Uint32` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as an `Uint32`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `Uint32` 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 `Uint32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as an `Uint32` (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 `Uint32`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as an `Uint32`.\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 `Uint32`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as an `Uint32`.\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 `Uint32`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as an `Uint32`.\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 `Uint32`\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 `Uint32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as an `Uint32`\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,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/enum/int8.d.mts

@@ -1,139 +1,135 @@
 import { type AbsoluteValue, type Int8 as TtfImported_Int8 } from 'ts-type-forge';
 export type Int8 = TtfImported_Int8;
 /**
- * Type guard that checks if a value is an 8-bit signed integer.
+ * Type guard that checks if a value is an integer in [-128, 127].
  *
- * An Int8 is a signed integer in the range [-128, 127], representing values
- * that fit in exactly 8 bits of memory.
+ * Returns `true` for an integer in [-128, 127] — a value with no fractional
+ * component.
  *
  * @param value - The value to check
- * @returns `true` if the value is an Int8, `false` otherwise
+ * @returns `true` if the value is an integer in [-128, 127], `false` otherwise
  */
 export declare const isInt8: (x: number) => x is Int8;
 /**
- * Casts a number to an Int8 branded type.
+ * Casts a `number` to the `Int8` branded type.
  *
- * This function validates that the input is within the Int8 range [-128, 127]
- * and is an integer, then returns it with the Int8 brand.
+ * Validates that the value is an integer in [-128, 127] and returns it with the
+ * `Int8` brand. Throws a `TypeError` otherwise.
  *
  * @param value - The value to cast
- * @returns The value as an Int8 branded type
- * @throws {TypeError} If the value is not a valid 8-bit signed integer
+ * @returns The value as an `Int8`
+ * @throws {TypeError} If the value is not an integer in [-128, 127]
  */
 export declare const asInt8: (x: number) => Int8;
 /**
- * Namespace providing type-safe operations for Int8 (8-bit signed integer)
- * branded types.
+ * Namespace providing type-safe operations for the `Int8` branded type.
  *
- * Int8 represents signed integers in the range [-128, 127], equivalent to a
- * signed byte in many programming languages. All operations automatically clamp
- * results to stay within this range, preventing overflow/underflow issues.
- *
- * This type is useful for:
- *
- * - Binary data processing (signed bytes)
- * - Small integer values with known bounds
- * - Embedded systems programming
- * - Memory-efficient integer storage
- * - Image processing (signed pixel offsets)
+ * The `Int8` type represents an integer in [-128, 127]. Division (`div`) uses
+ * floor division.
  */
 export declare const Int8: {
     /**
-     * Type guard that checks if a value is an 8-bit signed integer.
+     * Type guard that checks if a value is an integer in [-128, 127].
      *
      * @param value - The value to check
-     * @returns `true` if the value is in range [-128, 127] and is an integer
+     * @returns `true` if the value is an integer in [-128, 127], `false` otherwise
      * @see {@link isInt8} for usage examples
      */
     readonly is: (x: number) => x is Int8;
     /**
-     * The minimum value for an 8-bit signed integer.
-     *
-     * @readonly
+     * The smallest value representable as `Int8` (the lower saturation target of
+     * `fromNumber`).
      */
     readonly MIN_VALUE: -128;
     /**
-     * The maximum value for an 8-bit signed integer.
-     *
-     * @readonly
+     * The largest value representable as `Int8` (the upper saturation target of
+     * `fromNumber`).
      */
     readonly MAX_VALUE: 127;
     /**
-     * Returns the minimum value from a list of Int8 values.
+     * Returns the smallest of the given integers.
      *
-     * @param values - The Int8 values to compare (at least one required)
-     * @returns The smallest value as an Int8
+     * @param values - The integers to compare (at least one required)
+     * @returns The smallest value as an `Int8`
      */
     readonly min: (...values: readonly Int8[]) => Int8;
     /**
-     * Returns the maximum value from a list of Int8 values.
+     * Returns the largest of the given integers.
      *
-     * @param values - The Int8 values to compare (at least one required)
-     * @returns The largest value as an Int8
+     * @param values - The integers to compare (at least one required)
+     * @returns The largest value as an `Int8`
      */
     readonly max: (...values: readonly Int8[]) => Int8;
     /**
-     * Clamps a number to the Int8 range.
+     * Converts an arbitrary `number` into an `Int8`, rounding to the nearest
+     * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+     *
+     * Unlike `asInt8`, this is total: out-of-range inputs are clamped to the
+     * nearest representable `Int8` instead of throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [-128, 127] as an Int8.
+     * @param value - The value to convert
+     * @returns The value as an `Int8`
      */
-    readonly clamp: (a: number) => Int8;
+    readonly fromNumber: (a: number) => Int8;
     /**
-     * Returns the absolute value of an Int8.
+     * Returns the absolute value of an integer in [-128, 127].
+     *
+     * The result is non-negative and keeps the `Int8` brand.
      *
-     * @param value The Int8 value.
-     * @returns The absolute value as an Int8, clamped to valid range.
+     * @param a - The integer value
+     * @returns The absolute value as a non-negative `Int8`
      */
     readonly abs: <N extends Int8>(x: N) => AbsoluteValue<N>;
     /**
-     * Generates a random Int8 value within the specified range (inclusive).
+     * Generates a random `Int8` within the given range.
      *
-     * Both bounds are inclusive. If min > max, they are automatically swapped.
+     * The range is inclusive on both ends.
      *
      * @param min - The minimum value (inclusive)
      * @param max - The maximum value (inclusive)
-     * @returns A random Int8 in the range [min, max]
+     * @returns A random `Int8` in `[min, max]`
      */
     readonly random: (min: Int8, max: Int8) => Int8;
     /**
-     * Raises x to the power of y, clamped to Int8 range.
+     * Raises `a` to the power `b`, returning `a ** b` as an `Int8` (floored to an
+     * integer).
      *
-     * @param x - The base
-     * @param y - The exponent
-     * @returns `x ** y` clamped to [-128, 127]
+     * @param a - The base integer
+     * @param b - The exponent integer
+     * @returns `a ** b` as an `Int8`
      */
     readonly pow: (x: Int8, y: Int8) => Int8;
     /**
-     * Adds two Int8 values, clamped to Int8 range.
+     * Adds two integers, returning `a + b` as an `Int8`.
      *
-     * @param x - First operand
-     * @param y - Second operand
-     * @returns `x + y` clamped to [-128, 127]
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The sum of `a` and `b` as an `Int8`
      */
     readonly add: (x: Int8, y: Int8) => Int8;
     /**
-     * Subtracts two Int8 values, clamped to Int8 range.
+     * Subtracts two integers, returning `a - b` as an `Int8`.
      *
-     * @param x - First operand
-     * @param y - Second operand
-     * @returns `x - y` clamped to [-128, 127]
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The difference of `a` and `b` as an `Int8`
      */
     readonly sub: (x: Int8, y: Int8) => Int8;
     /**
-     * Multiplies two Int8 values, clamped to Int8 range.
+     * Multiplies two integers, returning `a * b` as an `Int8`.
      *
-     * @param x - First operand
-     * @param y - Second operand
-     * @returns `x * y` clamped to [-128, 127]
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The product of `a` and `b` as an `Int8`
      */
     readonly mul: (x: Int8, y: Int8) => Int8;
     /**
-     * Divides two Int8 values, clamped to Int8 range.
+     * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+     * b` rounded toward negative infinity, as an `Int8`.
      *
-     * @param x - The dividend
-     * @param y - The divisor (cannot be 0)
-     * @returns `⌊x / y⌋` clamped to [-128, 127]
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as an `Int8`
      */
     readonly div: (x: Int8, y: Exclude<Int8, 0>) => Int8;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"int8.d.mts","sourceRoot":"","sources":["../../../src/number/enum/int8.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAElB,KAAK,IAAI,IAAI,gBAAgB,EAC9B,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,IAAI,GAAG,gBAAgB,CAAC;AAqDpC;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,MAxCJ,MAAM,KAAG,CAAC,IAAI,IAwCL,CAAC;AAEzB;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM,MAlDE,MAAM,KAAG,IAkDA,CAAC;AAE/B;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,IAAI;IACf;;;;;;OAMG;qBA7EU,MAAM,KAAG,CAAC,IAAI,IAAI;IAgF/B;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;8BAvFoB,SAAS,IAAI,EAAE,KAAG,IAAI;IA0F7C;;;;;OAKG;8BA5FoB,SAAS,IAAI,EAAE,KAAG,IAAI;IA+F7C;;;;;OAKG;wBA7Ga,MAAM,KAAG,IAAI;IAgH7B;;;;;OAKG;mBAnHQ,CAAC,SAAS,IAAI,KAAK,CAAC,KAAG,aAAa,CAAC,CAAC,CAAC;IAsHlD;;;;;;;;OAQG;2BA1GgB,IAAI,OAAO,IAAI,KAAG,IAAI;IA6GzC;;;;;;OAMG;sBA7HW,IAAI,KAAK,IAAI,KAAG,IAAI;IAgIlC;;;;;;OAMG;sBApIW,IAAI,KAAK,IAAI,KAAG,IAAI;IAuIlC;;;;;;OAMG;sBA3IW,IAAI,KAAK,IAAI,KAAG,IAAI;IA8IlC;;;;;;OAMG;sBAlJW,IAAI,KAAK,IAAI,KAAG,IAAI;IAqJlC;;;;;;OAMG;sBAzJW,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAG,IAAI;CA2JtC,CAAC"}
+{"version":3,"file":"int8.d.mts","sourceRoot":"","sources":["../../../src/number/enum/int8.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAElB,KAAK,IAAI,IAAI,gBAAgB,EAC9B,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,IAAI,GAAG,gBAAgB,CAAC;AAsDpC;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,MAzCJ,MAAM,KAAG,CAAC,IAAI,IAyCL,CAAC;AAEzB;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM,MAnDE,MAAM,KAAG,IAmDA,CAAC;AAE/B;;;;;GAKG;AACH,eAAO,MAAM,IAAI;IACf;;;;;;OAMG;qBApEU,MAAM,KAAG,CAAC,IAAI,IAAI;IAuE/B;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;8BA5EoB,SAAS,IAAI,EAAE,KAAG,IAAI;IA+E7C;;;;;OAKG;8BAjFoB,SAAS,IAAI,EAAE,KAAG,IAAI;IAoF7C;;;;;;;;;OASG;6BAtGkB,MAAM,KAAG,IAAI;IAyGlC;;;;;;;OAOG;mBA9GQ,CAAC,SAAS,IAAI,KAAK,CAAC,KAAG,aAAa,CAAC,CAAC,CAAC;IAiHlD;;;;;;;;OAQG;2BApGgB,IAAI,OAAO,IAAI,KAAG,IAAI;IAuGzC;;;;;;;OAOG;sBAzHW,IAAI,KAAK,IAAI,KAAG,IAAI;IA4HlC;;;;;;OAMG;sBAhIW,IAAI,KAAK,IAAI,KAAG,IAAI;IAmIlC;;;;;;OAMG;sBAvIW,IAAI,KAAK,IAAI,KAAG,IAAI;IA0IlC;;;;;;OAMG;sBA9IW,IAAI,KAAK,IAAI,KAAG,IAAI;IAiJlC;;;;;;;OAOG;sBAtJW,IAAI,KAAK,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAG,IAAI;CAwJtC,CAAC"}

package/dist/number/enum/int8.mjs

@@ -5,7 +5,7 @@ const {
   MAX_VALUE,
   MIN_VALUE,
   castType: castTypeImpl,
-  clamp: clampImpl,
+  fromNumber: fromNumberImpl,
   is: isImpl,
   random: randomImpl
 } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
@@ -19,118 +19,124 @@ const castType = (x) => (
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
   castTypeImpl(x)
 );
-const clamp = (a) => castType(clampImpl(a));
+const fromNumber = (a) => castType(fromNumberImpl(a));
 const abs = (x) => (
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
   Math.abs(x)
 );
 const min_ = (...values) => castType(Math.min(...values));
 const max_ = (...values) => castType(Math.max(...values));
-const pow = (x, y) => clamp(x ** y);
-const add = (x, y) => clamp(x + y);
-const sub = (x, y) => clamp(x - y);
-const mul = (x, y) => clamp(x * y);
-const div = (x, y) => clamp(Math.floor(x / y));
+const pow = (x, y) => fromNumber(x ** y);
+const add = (x, y) => fromNumber(x + y);
+const sub = (x, y) => fromNumber(x - y);
+const mul = (x, y) => fromNumber(x * y);
+const div = (x, y) => fromNumber(Math.floor(x / y));
 const random = (min, max) => castType(randomImpl(castTypeImpl(min), castTypeImpl(max)));
 const isInt8 = is;
 const asInt8 = castType;
 const Int8 = {
   /**
-   * Type guard that checks if a value is an 8-bit signed integer.
+   * Type guard that checks if a value is an integer in [-128, 127].
    *
    * @param value - The value to check
-   * @returns `true` if the value is in range [-128, 127] and is an integer
+   * @returns `true` if the value is an integer in [-128, 127], `false` otherwise
    * @see {@link isInt8} for usage examples
    */
   is,
   /**
-   * The minimum value for an 8-bit signed integer.
-   *
-   * @readonly
+   * The smallest value representable as `Int8` (the lower saturation target of
+   * `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum value for an 8-bit signed integer.
-   *
-   * @readonly
+   * The largest value representable as `Int8` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * Returns the minimum value from a list of Int8 values.
+   * Returns the smallest of the given integers.
    *
-   * @param values - The Int8 values to compare (at least one required)
-   * @returns The smallest value as an Int8
+   * @param values - The integers to compare (at least one required)
+   * @returns The smallest value as an `Int8`
    */
   min: min_,
   /**
-   * Returns the maximum value from a list of Int8 values.
+   * Returns the largest of the given integers.
    *
-   * @param values - The Int8 values to compare (at least one required)
-   * @returns The largest value as an Int8
+   * @param values - The integers to compare (at least one required)
+   * @returns The largest value as an `Int8`
    */
   max: max_,
   /**
-   * Clamps a number to the Int8 range.
+   * Converts an arbitrary `number` into an `Int8`, 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 [-128, 127] as an Int8.
+   * Unlike `asInt8`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Int8` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as an `Int8`
    */
-  clamp,
+  fromNumber,
   /**
-   * Returns the absolute value of an Int8.
+   * Returns the absolute value of an integer in [-128, 127].
+   *
+   * The result is non-negative and keeps the `Int8` brand.
    *
-   * @param value The Int8 value.
-   * @returns The absolute value as an Int8, clamped to valid range.
+   * @param a - The integer value
+   * @returns The absolute value as a non-negative `Int8`
    */
   abs,
   /**
-   * Generates a random Int8 value within the specified range (inclusive).
+   * Generates a random `Int8` within the given range.
    *
-   * Both bounds are inclusive. If min > max, they are automatically swapped.
+   * The range is inclusive on both ends.
    *
    * @param min - The minimum value (inclusive)
    * @param max - The maximum value (inclusive)
-   * @returns A random Int8 in the range [min, max]
+   * @returns A random `Int8` in `[min, max]`
    */
   random,
   /**
-   * Raises x to the power of y, clamped to Int8 range.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Int8` (floored to an
+   * integer).
    *
-   * @param x - The base
-   * @param y - The exponent
-   * @returns `x ** y` clamped to [-128, 127]
+   * @param a - The base integer
+   * @param b - The exponent integer
+   * @returns `a ** b` as an `Int8`
    */
   pow,
   /**
-   * Adds two Int8 values, clamped to Int8 range.
+   * Adds two integers, returning `a + b` as an `Int8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x + y` clamped to [-128, 127]
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The sum of `a` and `b` as an `Int8`
    */
   add,
   /**
-   * Subtracts two Int8 values, clamped to Int8 range.
+   * Subtracts two integers, returning `a - b` as an `Int8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x - y` clamped to [-128, 127]
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The difference of `a` and `b` as an `Int8`
    */
   sub,
   /**
-   * Multiplies two Int8 values, clamped to Int8 range.
+   * Multiplies two integers, returning `a * b` as an `Int8`.
    *
-   * @param x - First operand
-   * @param y - Second operand
-   * @returns `x * y` clamped to [-128, 127]
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The product of `a` and `b` as an `Int8`
    */
   mul,
   /**
-   * Divides two Int8 values, clamped to Int8 range.
+   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+   * b` rounded toward negative infinity, as an `Int8`.
    *
-   * @param x - The dividend
-   * @param y - The divisor (cannot be 0)
-   * @returns `⌊x / y⌋` clamped to [-128, 127]
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Int8`
    */
   div
 };