ts-data-forge 11.0.1 → 12.1.0

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

@@ -12,8 +12,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -107,7 +107,8 @@ export const Uint = {
   is,
 
   /**
-   * The smallest value representable as `Uint`.
+   * The smallest value representable as `Uint` (the lower saturation target of
+   * `fromNumber`).
    */
   MIN_VALUE,
 
@@ -144,25 +145,28 @@ export const Uint = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `Uint` range, rounding to the nearest integer
-   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into an `Uint`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asUint`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Uint` instead of throwing.
    *
    * @example
    *
    * ```ts
-   * const clampedNegative = Uint.clamp(-5);
+   * const fromNegative = Uint.fromNumber(-5);
    *
-   * const clampedPositive = Uint.clamp(42);
+   * const fromPositive = Uint.fromNumber(42);
    *
-   * assert.isTrue(clampedNegative === 0);
+   * assert.isTrue(fromNegative === 0);
    *
-   * assert.isTrue(clampedPositive === 42);
+   * assert.isTrue(fromPositive === 42);
    * ```
    *
-   * @param value - The value to clamp
-   * @returns The clamped value as an `Uint`
+   * @param value - The value to convert
+   * @returns The value as an `Uint`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `Uint` within the given range.

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

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -73,12 +73,14 @@ export const Uint16 = {
   is,
 
   /**
-   * The smallest value representable as `Uint16`.
+   * The smallest value representable as `Uint16` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `Uint16`.
+   * The largest value representable as `Uint16` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
 
@@ -99,13 +101,16 @@ export const Uint16 = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `Uint16` range, rounding to the nearest integer
-   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * 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 value to clamp
-   * @returns The clamped value as an `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` within the given range.

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

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -73,12 +73,14 @@ export const Uint32 = {
   is,
 
   /**
-   * The smallest value representable as `Uint32`.
+   * The smallest value representable as `Uint32` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `Uint32`.
+   * The largest value representable as `Uint32` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
 
@@ -99,13 +101,16 @@ export const Uint32 = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `Uint32` range, rounding to the nearest integer
-   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * 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
-   * @returns The clamped value as an `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` within the given range.

package/src/number/enum/int8.mts

@@ -14,7 +14,7 @@ const {
   MAX_VALUE,
   MIN_VALUE,
   castType: castTypeImpl,
-  clamp: clampImpl,
+  fromNumber: fromNumberImpl,
   is: isImpl,
   random: randomImpl,
 } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<
@@ -34,7 +34,7 @@ const castType = (x: number): Int8 =>
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
   castTypeImpl(x) as Int8;
 
-const clamp = (a: number): Int8 => castType(clampImpl(a));
+const fromNumber = (a: number): Int8 => castType(fromNumberImpl(a));
 
 const abs = <N extends Int8>(x: N): AbsoluteValue<N> =>
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
@@ -46,15 +46,16 @@ const min_ = (...values: readonly Int8[]): Int8 =>
 const max_ = (...values: readonly Int8[]): Int8 =>
   castType(Math.max(...values));
 
-const pow = (x: Int8, y: Int8): Int8 => clamp(x ** y);
+const pow = (x: Int8, y: Int8): Int8 => fromNumber(x ** y);
 
-const add = (x: Int8, y: Int8): Int8 => clamp(x + y);
+const add = (x: Int8, y: Int8): Int8 => fromNumber(x + y);
 
-const sub = (x: Int8, y: Int8): Int8 => clamp(x - y);
+const sub = (x: Int8, y: Int8): Int8 => fromNumber(x - y);
 
-const mul = (x: Int8, y: Int8): Int8 => clamp(x * y);
+const mul = (x: Int8, y: Int8): Int8 => fromNumber(x * y);
 
-const div = (x: Int8, y: Exclude<Int8, 0>): Int8 => clamp(Math.floor(x / y));
+const div = (x: Int8, y: Exclude<Int8, 0>): Int8 =>
+  fromNumber(Math.floor(x / y));
 
 const random = (min: Int8, max: Int8): Int8 =>
   castType(randomImpl(castTypeImpl(min), castTypeImpl(max)));
@@ -99,12 +100,14 @@ export const Int8 = {
   is,
 
   /**
-   * The smallest value representable as `Int8`.
+   * The smallest value representable as `Int8` (the lower saturation target of
+   * `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `Int8`.
+   * The largest value representable as `Int8` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
 
@@ -125,13 +128,16 @@ export const Int8 = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `Int8` range, rounding to the nearest integer
-   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * 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 value to clamp
-   * @returns The clamped value 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 integer in [-128, 127].

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

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

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,15 +36,16 @@ 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)));
@@ -89,12 +90,14 @@ export const Uint8 = {
   is,
 
   /**
-   * The smallest value representable as `Uint8`.
+   * The smallest value representable as `Uint8` (the lower saturation target of
+   * `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `Uint8`.
+   * The largest value representable as `Uint8` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
 
@@ -115,13 +118,16 @@ export const Uint8 = {
   min: min_,
 
   /**
-   * Clamps a `number` into the `Uint8` range, rounding to the nearest integer
-   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into an `Uint8`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value - The value to clamp
-   * @returns The clamped value as an `Uint8`
+   * Unlike `asUint8`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Uint8` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as an `Uint8`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `Uint8` within the given range.

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;