ts-data-forge 11.0.1 → 12.0.0

package/src/number/branded-types/positive-int16.mts

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -74,12 +74,14 @@ export const PositiveInt16 = {
   is,
 
   /**
-   * The smallest value representable as `PositiveInt16`.
+   * The smallest value representable as `PositiveInt16` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `PositiveInt16`.
+   * The largest value representable as `PositiveInt16` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -100,13 +102,17 @@ export const PositiveInt16 = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `PositiveInt16` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `PositiveInt16`, 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 a `PositiveInt16`
+   * Unlike `asPositiveInt16`, this is total: out-of-range inputs are clamped to
+   * the nearest representable `PositiveInt16` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `PositiveInt16`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `PositiveInt16` within the given range.

package/src/number/branded-types/positive-int32.mts

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -74,12 +74,14 @@ export const PositiveInt32 = {
   is,
 
   /**
-   * The smallest value representable as `PositiveInt32`.
+   * The smallest value representable as `PositiveInt32` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `PositiveInt32`.
+   * The largest value representable as `PositiveInt32` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -100,13 +102,17 @@ export const PositiveInt32 = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `PositiveInt32` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `PositiveInt32`, 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 a `PositiveInt32`
+   * Unlike `asPositiveInt32`, this is total: out-of-range inputs are clamped to
+   * the nearest representable `PositiveInt32` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `PositiveInt32`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `PositiveInt32` within the given range.

package/src/number/branded-types/positive-safe-int.mts

@@ -16,8 +16,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -112,12 +112,14 @@ export const PositiveSafeInt = {
   is,
 
   /**
-   * The smallest value representable as `PositiveSafeInt`.
+   * The smallest value representable as `PositiveSafeInt` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `PositiveSafeInt`.
+   * The largest value representable as `PositiveSafeInt` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -160,17 +162,21 @@ export const PositiveSafeInt = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `PositiveSafeInt` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `PositiveSafeInt`, rounding to the
+   * nearest integer and saturating the result into the range `[MIN_VALUE,
+   * MAX_VALUE]`.
+   *
+   * Unlike `asPositiveSafeInt`, this is total: out-of-range inputs are clamped
+   * to the nearest representable `PositiveSafeInt` instead of throwing.
    *
    * @example
    *
    * ```ts
-   * const belowRange = PositiveSafeInt.clamp(0);
+   * const belowRange = PositiveSafeInt.fromNumber(0);
    *
-   * const withinRange = PositiveSafeInt.clamp(123);
+   * const withinRange = PositiveSafeInt.fromNumber(123);
    *
-   * const aboveRange = PositiveSafeInt.clamp(Number.MAX_SAFE_INTEGER + 10);
+   * const aboveRange = PositiveSafeInt.fromNumber(Number.MAX_SAFE_INTEGER + 10);
    *
    * assert.isTrue(belowRange === 1);
    *
@@ -179,10 +185,10 @@ export const PositiveSafeInt = {
    * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
    * ```
    *
-   * @param value - The value to clamp
-   * @returns The clamped value as a `PositiveSafeInt`
+   * @param value - The value to convert
+   * @returns The value as a `PositiveSafeInt`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `PositiveSafeInt` within the given range.

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

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -74,12 +74,14 @@ export const PositiveUint16 = {
   is,
 
   /**
-   * The smallest value representable as `PositiveUint16`.
+   * The smallest value representable as `PositiveUint16` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `PositiveUint16`.
+   * The largest value representable as `PositiveUint16` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -100,13 +102,17 @@ export const PositiveUint16 = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `PositiveUint16` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `PositiveUint16`, 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 a `PositiveUint16`
+   * Unlike `asPositiveUint16`, this is total: out-of-range inputs are clamped
+   * to the nearest representable `PositiveUint16` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `PositiveUint16`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `PositiveUint16` within the given range.

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

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -74,12 +74,14 @@ export const PositiveUint32 = {
   is,
 
   /**
-   * The smallest value representable as `PositiveUint32`.
+   * The smallest value representable as `PositiveUint32` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `PositiveUint32`.
+   * The largest value representable as `PositiveUint32` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -100,13 +102,17 @@ export const PositiveUint32 = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `PositiveUint32` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `PositiveUint32`, 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 a `PositiveUint32`
+   * Unlike `asPositiveUint32`, this is total: out-of-range inputs are clamped
+   * to the nearest representable `PositiveUint32` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `PositiveUint32`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `PositiveUint32` within the given range.

package/src/number/branded-types/safe-int.mts

@@ -17,8 +17,8 @@ const {
   abs,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -108,12 +108,14 @@ export const SafeInt = {
   is,
 
   /**
-   * The smallest value representable as `SafeInt`.
+   * The smallest value representable as `SafeInt` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `SafeInt`.
+   * The largest value representable as `SafeInt` (the upper saturation target
+   * of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -172,17 +174,20 @@ export const SafeInt = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `SafeInt` range, rounding to the nearest integer
-   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `SafeInt`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asSafeInt`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `SafeInt` instead of throwing.
    *
    * @example
    *
    * ```ts
-   * const aboveRange = SafeInt.clamp(1e20);
+   * const aboveRange = SafeInt.fromNumber(1e20);
    *
-   * const withinRange = SafeInt.clamp(123);
+   * const withinRange = SafeInt.fromNumber(123);
    *
-   * const belowRange = SafeInt.clamp(-1e20);
+   * const belowRange = SafeInt.fromNumber(-1e20);
    *
    * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
    *
@@ -191,10 +196,10 @@ export const SafeInt = {
    * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);
    * ```
    *
-   * @param value - The value to clamp
-   * @returns The clamped value as a `SafeInt`
+   * @param value - The value to convert
+   * @returns The value as a `SafeInt`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `SafeInt` within the given range.

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

@@ -13,8 +13,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -74,12 +74,14 @@ export const SafeUint = {
   is,
 
   /**
-   * The smallest value representable as `SafeUint`.
+   * The smallest value representable as `SafeUint` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `SafeUint`.
+   * The largest value representable as `SafeUint` (the upper saturation target
+   * of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -100,13 +102,16 @@ export const SafeUint = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `SafeUint` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `SafeUint`, 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 a `SafeUint`
+   * Unlike `asSafeUint`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `SafeUint` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `SafeUint`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `SafeUint` within the given range.

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', () => {