ts-data-forge 11.0.0 → 12.0.0

package/src/number/enum/uint8.mts

@@ -10,7 +10,7 @@ const {
   MAX_VALUE,
   MIN_VALUE,
   castType: castTypeImpl,
-  clamp: clampImpl,
+  fromNumber: fromNumberImpl,
   is: isImpl,
   random: randomImpl,
 } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<Uint16, 0, 255>(
@@ -28,7 +28,7 @@ const castType = (x: number): Uint8 =>
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
   castTypeImpl(x) as Uint8;
 
-const clamp = (a: number): Uint8 => castType(clampImpl(a));
+const fromNumber = (a: number): Uint8 => castType(fromNumberImpl(a));
 
 const min_ = (...values: readonly Uint8[]): Uint8 =>
   castType(Math.min(...values));
@@ -36,146 +36,154 @@ const min_ = (...values: readonly Uint8[]): Uint8 =>
 const max_ = (...values: readonly Uint8[]): Uint8 =>
   castType(Math.max(...values));
 
-const pow = (x: Uint8, y: Uint8): Uint8 => clamp(x ** y);
+const pow = (x: Uint8, y: Uint8): Uint8 => fromNumber(x ** y);
 
-const add = (x: Uint8, y: Uint8): Uint8 => clamp(x + y);
+const add = (x: Uint8, y: Uint8): Uint8 => fromNumber(x + y);
 
-const sub = (x: Uint8, y: Uint8): Uint8 => clamp(x - y);
+const sub = (x: Uint8, y: Uint8): Uint8 => fromNumber(x - y);
 
-const mul = (x: Uint8, y: Uint8): Uint8 => clamp(x * y);
+const mul = (x: Uint8, y: Uint8): Uint8 => fromNumber(x * y);
 
-const div = (x: Uint8, y: Exclude<Uint8, 0>): Uint8 => clamp(Math.floor(x / y));
+const div = (x: Uint8, y: Exclude<Uint8, 0>): Uint8 =>
+  fromNumber(Math.floor(x / y));
 
 const random = (min: Uint8, max: Uint8): Uint8 =>
   castType(randomImpl(castTypeImpl(min), castTypeImpl(max)));
 
 /**
- * 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 const isUint8 = is;
 
 /**
- * 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 const asUint8 = castType;
 
 /**
- * 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 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` (the lower saturation target of
+   * `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The maximum value for an 8-bit unsigned integer.
-   *
-   * @readonly
+   * The largest value representable as `Uint8` (the upper saturation target of
+   * `fromNumber`).
    */
   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.
+   * Converts an arbitrary `number` into an `Uint8`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asUint8`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Uint8` instead of throwing.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, 255] as a Uint8.
+   * @param value - The value to convert
+   * @returns The value as an `Uint8`
    */
-  clamp,
+  fromNumber,
 
   /**
-   * 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,
 } as const;

package/src/number/enum/uint8.test.mts

@@ -61,7 +61,7 @@ describe('Uint8 test', () => {
     });
   });
 
-  describe('Uint8.clamp', () => {
+  describe('Uint8.fromNumber', () => {
     test.each([
       { value: -100, expected: 0 },
       { value: 0, expected: 0 },
@@ -69,9 +69,12 @@ describe('Uint8 test', () => {
       { value: 255, expected: 255 },
       { value: 300, expected: 255 },
       { value: 1.5, expected: 2 },
-    ])('Uint8.clamp($value) should return $expected', ({ expected, value }) => {
-      expect(Uint8.clamp(value)).toBe(expected);
-    });
+    ])(
+      'Uint8.fromNumber($value) should return $expected',
+      ({ expected, value }) => {
+        expect(Uint8.fromNumber(value)).toBe(expected);
+      },
+    );
   });
 
   describe('Uint8.min', () => {

package/src/number/refined-number-utils.mts

@@ -144,7 +144,7 @@ export namespace TsDataForgeInternals {
       ('non-negative' extends classes
         ? Readonly<{
             MIN_VALUE: number;
-            clamp: (a: number) => N;
+            fromNumber: (a: number) => N;
           }>
         : unknown) &
       ('non-negative' extends classes
@@ -157,14 +157,14 @@ export namespace TsDataForgeInternals {
       ('positive' extends classes
         ? Readonly<{
             MIN_VALUE: number;
-            clamp: (a: number) => N;
+            fromNumber: (a: number) => N;
           }>
         : unknown) &
       ('range' extends classes
         ? Readonly<{
             MIN_VALUE: number;
             MAX_VALUE: number;
-            clamp: (a: number) => N;
+            fromNumber: (a: number) => N;
           }>
         : unknown) &
       Pick<
@@ -200,17 +200,17 @@ export namespace TsDataForgeInternals {
 
     expectType<
       keyof NumberClass<UnknownNumberBrand, 'non-negative'>,
-      BaseKeys | FloatMethods | 'clamp' | 'MIN_VALUE'
+      BaseKeys | FloatMethods | 'fromNumber' | 'MIN_VALUE'
     >('=');
 
     expectType<
       keyof NumberClass<UnknownNumberBrand, 'positive'>,
-      BaseKeys | FloatMethods | 'clamp' | 'MIN_VALUE'
+      BaseKeys | FloatMethods | 'fromNumber' | 'MIN_VALUE'
     >('=');
 
     expectType<
       keyof NumberClass<UnknownNumberBrand, 'int' | 'range'>,
-      BaseKeys | 'abs' | 'clamp' | 'MAX_VALUE' | 'MIN_VALUE'
+      BaseKeys | 'abs' | 'fromNumber' | 'MAX_VALUE' | 'MIN_VALUE'
     >('=');
 
     const isFnOrUndefined = (
@@ -292,7 +292,7 @@ export namespace TsDataForgeInternals {
 
       castType: <N extends number>(x: N) => ElementType & N;
 
-      clamp: TypeEq<MAX_VALUE | MIN_VALUE, undefined> extends true
+      fromNumber: TypeEq<MAX_VALUE | MIN_VALUE, undefined> extends true
         ? undefined
         : (x: number) => ElementType;
     }>;
@@ -337,7 +337,7 @@ export namespace TsDataForgeInternals {
      *
      * const quotient = intOps.div(six, intOps.castType(2));
      *
-     * const roundedClamp = intOps.clamp(1.5);
+     * const coerced = intOps.fromNumber(1.5);
      *
      * const randomValue = intOps.random();
      *
@@ -349,7 +349,7 @@ export namespace TsDataForgeInternals {
      *
      * assert.isTrue(quotient === 3);
      *
-     * assert.isTrue(roundedClamp === 2);
+     * assert.isTrue(coerced === 2);
      *
      * assert.isTrue(Number.isSafeInteger(randomValue));
      * ```
@@ -396,7 +396,7 @@ export namespace TsDataForgeInternals {
 
       const castType = castTypeImpl<ElementType>(is, typeNameInMessage);
 
-      const clamp: ((a: number) => ElementType) | undefined = pipe(
+      const fromNumber: ((a: number) => ElementType) | undefined = pipe(
         clampFnOrUndefined(MIN_VALUE, MAX_VALUE),
       ).mapNullable(
         (cl) =>
@@ -404,7 +404,7 @@ export namespace TsDataForgeInternals {
             castType(Math.round(cl(x))),
       ).value;
 
-      const clampOrCastFn: (a: number) => ElementType = clamp ?? castType;
+      const clampOrCastFn: (a: number) => ElementType = fromNumber ?? castType;
 
       const abs = (x: ElementTypeWithSmallInt): ToNonNegative<ElementType> =>
         // eslint-disable-next-line total-functions/no-unsafe-type-assertion
@@ -488,9 +488,9 @@ export namespace TsDataForgeInternals {
         randomNonZero,
         castType,
 
-        clamp:
+        fromNumber:
           // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-          clamp as TypeEq<MAX_VALUE | MIN_VALUE, undefined> extends true
+          fromNumber as TypeEq<MAX_VALUE | MIN_VALUE, undefined> extends true
             ? undefined
             : (x: number) => ElementType,
       } as const;
@@ -519,7 +519,7 @@ export namespace TsDataForgeInternals {
 
       castType: <N extends number>(x: N) => ElementType & N;
 
-      clamp: TypeEq<MAX_VALUE | MIN_VALUE, undefined> extends true
+      fromNumber: TypeEq<MAX_VALUE | MIN_VALUE, undefined> extends true
         ? undefined
         : (x: number) => ElementType;
     }>;
@@ -560,7 +560,7 @@ export namespace TsDataForgeInternals {
      *
      * const ratio = floatOps.div(sum, floatOps.castType(10));
      *
-     * const clamped = floatOps.clamp(0);
+     * const coerced = floatOps.fromNumber(0);
      *
      * const boundedRandom = floatOps.random(
      *   floatOps.castType(10),
@@ -573,7 +573,7 @@ export namespace TsDataForgeInternals {
      *
      * assert.isTrue(ratio === 5);
      *
-     * assert.isTrue(clamped >= Number.MIN_VALUE);
+     * assert.isTrue(coerced >= Number.MIN_VALUE);
      *
      * assert.isTrue(boundedRandom >= 10 && boundedRandom <= 20);
      *
@@ -615,7 +615,7 @@ export namespace TsDataForgeInternals {
 
       const castType = castTypeImpl<ElementType>(is, typeNameInMessage);
 
-      const clamp: ((a: number) => ElementType) | undefined = pipe(
+      const fromNumber: ((a: number) => ElementType) | undefined = pipe(
         clampFnOrUndefined(MIN_VALUE, MAX_VALUE),
       ).mapNullable(
         (cl) =>
@@ -623,7 +623,7 @@ export namespace TsDataForgeInternals {
             castType(cl(x)),
       ).value;
 
-      const clampOrCastFn: (a: number) => ElementType = clamp ?? castType;
+      const clampOrCastFn: (a: number) => ElementType = fromNumber ?? castType;
 
       const abs = (x: ElementType): ToNonNegative<ElementType> =>
         // eslint-disable-next-line total-functions/no-unsafe-type-assertion
@@ -687,7 +687,10 @@ export namespace TsDataForgeInternals {
         castType,
 
         // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-        clamp: clamp as TypeEq<MAX_VALUE | MIN_VALUE, undefined> extends true
+        fromNumber: fromNumber as TypeEq<
+          MAX_VALUE | MIN_VALUE,
+          undefined
+        > extends true
           ? undefined
           : (x: number) => ElementType,
       } as const;