ts-data-forge 11.0.1 → 12.1.0

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

@@ -15,7 +15,7 @@ const {
   MAX_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -35,7 +35,7 @@ const {
 } as const);
 
 const abs = (x: WithSmallInt<ElementType>): PositiveInt =>
-  PositiveInt.clamp(Math.abs(x));
+  PositiveInt.fromNumber(Math.abs(x));
 
 /**
  * Type guard that checks if a value is a negative integer.
@@ -81,7 +81,8 @@ export const NegativeInt = {
   is,
 
   /**
-   * The largest value representable as `NegativeInt`.
+   * The largest value representable as `NegativeInt` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -114,13 +115,17 @@ export const NegativeInt = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `NegativeInt` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `NegativeInt`, 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 `NegativeInt`
+   * Unlike `asNegativeInt`, this is total: out-of-range inputs are clamped to
+   * the nearest representable `NegativeInt` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NegativeInt`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `NegativeInt` within the given range.

package/src/number/branded-types/negative-int.test.mts

@@ -96,17 +96,17 @@ describe('NegativeInt test', () => {
     });
   });
 
-  describe('NegativeInt.clamp', () => {
+  describe('NegativeInt.fromNumber', () => {
     test('returns the same value if within range', () => {
-      expect(NegativeInt.clamp(-5)).toBe(-5);
+      expect(NegativeInt.fromNumber(-5)).toBe(-5);
 
-      expect(NegativeInt.clamp(-1000)).toBe(-1000);
+      expect(NegativeInt.fromNumber(-1000)).toBe(-1000);
     });
 
     test('clamps non-negative values to MAX_VALUE (-1)', () => {
-      expect(NegativeInt.clamp(0)).toBe(-1);
+      expect(NegativeInt.fromNumber(0)).toBe(-1);
 
-      expect(NegativeInt.clamp(5)).toBe(-1);
+      expect(NegativeInt.fromNumber(5)).toBe(-1);
     });
   });
 

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

@@ -16,7 +16,7 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -36,7 +36,7 @@ const {
 } as const);
 
 const abs = (x: WithSmallInt<ElementType>): PositiveSafeInt =>
-  PositiveSafeInt.clamp(Math.abs(x));
+  PositiveSafeInt.fromNumber(Math.abs(x));
 
 /**
  * Type guard that checks if a value is a negative safe integer.
@@ -79,12 +79,14 @@ export const NegativeSafeInt = {
   is,
 
   /**
-   * The smallest value representable as `NegativeSafeInt`.
+   * The smallest value representable as `NegativeSafeInt` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
   /**
-   * The largest value representable as `NegativeSafeInt`.
+   * The largest value representable as `NegativeSafeInt` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -115,13 +117,17 @@ export const NegativeSafeInt = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `NegativeSafeInt` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `NegativeSafeInt`, 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 `NegativeSafeInt`
+   * Unlike `asNegativeSafeInt`, this is total: out-of-range inputs are clamped
+   * to the nearest representable `NegativeSafeInt` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NegativeSafeInt`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `NegativeSafeInt` within the given range.

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

@@ -86,13 +86,13 @@ describe('NegativeSafeInt test', () => {
     });
   });
 
-  describe('NegativeSafeInt.clamp', () => {
+  describe('NegativeSafeInt.fromNumber', () => {
     test('clamps to the valid range', () => {
-      expect(NegativeSafeInt.clamp(-5)).toBe(-5);
+      expect(NegativeSafeInt.fromNumber(-5)).toBe(-5);
 
-      expect(NegativeSafeInt.clamp(0)).toBe(-1);
+      expect(NegativeSafeInt.fromNumber(0)).toBe(-1);
 
-      expect(NegativeSafeInt.clamp(Number.MIN_SAFE_INTEGER - 100)).toBe(
+      expect(NegativeSafeInt.fromNumber(Number.MIN_SAFE_INTEGER - 100)).toBe(
         Number.MIN_SAFE_INTEGER,
       );
     });

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

@@ -15,8 +15,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -96,7 +96,8 @@ export const NonNegativeFiniteNumber = {
   is,
 
   /**
-   * The smallest value representable as `NonNegativeFiniteNumber`.
+   * The smallest value representable as `NonNegativeFiniteNumber` (the lower
+   * saturation target of `fromNumber`).
    */
   MIN_VALUE,
 
@@ -117,13 +118,17 @@ export const NonNegativeFiniteNumber = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `NonNegativeFiniteNumber` range `[MIN_VALUE,
-   * MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `NonNegativeFiniteNumber`, saturating
+   * it into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value - The value to clamp
-   * @returns The clamped value as a `NonNegativeFiniteNumber`
+   * Unlike `asNonNegativeFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `NonNegativeFiniteNumber` instead of
+   * throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NonNegativeFiniteNumber`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Returns the greatest integer less than or equal to a non-negative finite

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

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

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

@@ -11,7 +11,7 @@ const {
   MAX_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -102,7 +102,8 @@ export const NonPositiveFiniteNumber = {
   is,
 
   /**
-   * The largest value representable as `NonPositiveFiniteNumber`.
+   * The largest value representable as `NonPositiveFiniteNumber` (the upper
+   * saturation target of `fromNumber`).
    */
   MAX_VALUE,
 
@@ -123,13 +124,17 @@ export const NonPositiveFiniteNumber = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `NonPositiveFiniteNumber` range `[MIN_VALUE,
-   * MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `NonPositiveFiniteNumber`, saturating
+   * it into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value - The value to clamp
-   * @returns The clamped value as a `NonPositiveFiniteNumber`
+   * Unlike `asNonPositiveFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `NonPositiveFiniteNumber` instead of
+   * throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NonPositiveFiniteNumber`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Returns the greatest integer less than or equal to a non-positive finite

package/src/number/branded-types/non-positive-finite-number.test.mts

@@ -139,23 +139,23 @@ describe('NonPositiveFiniteNumber test', () => {
     });
   });
 
-  describe('NonPositiveFiniteNumber.clamp', () => {
+  describe('NonPositiveFiniteNumber.fromNumber', () => {
     test('returns the same value if within range', () => {
-      expect(NonPositiveFiniteNumber.clamp(-5.5)).toBe(-5.5);
+      expect(NonPositiveFiniteNumber.fromNumber(-5.5)).toBe(-5.5);
 
-      expect(NonPositiveFiniteNumber.clamp(0)).toBe(0);
+      expect(NonPositiveFiniteNumber.fromNumber(0)).toBe(0);
 
-      expect(NonPositiveFiniteNumber.clamp(-1000.5)).toBe(-1000.5);
+      expect(NonPositiveFiniteNumber.fromNumber(-1000.5)).toBe(-1000.5);
     });
 
     test('clamps positive values to MAX_VALUE (0)', () => {
-      expect(NonPositiveFiniteNumber.clamp(5.5)).toBe(0);
+      expect(NonPositiveFiniteNumber.fromNumber(5.5)).toBe(0);
 
-      expect(NonPositiveFiniteNumber.clamp(1000)).toBe(0);
+      expect(NonPositiveFiniteNumber.fromNumber(1000)).toBe(0);
     });
 
     test('clamps -Infinity to the lower bound', () => {
-      expect(NonPositiveFiniteNumber.clamp(Number.NEGATIVE_INFINITY)).toBe(
+      expect(NonPositiveFiniteNumber.fromNumber(Number.NEGATIVE_INFINITY)).toBe(
         -Number.MAX_VALUE,
       );
     });

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

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

package/src/number/branded-types/non-positive-int.test.mts

@@ -131,23 +131,23 @@ describe('NonPositiveInt test', () => {
     });
   });
 
-  describe('NonPositiveInt.clamp', () => {
+  describe('NonPositiveInt.fromNumber', () => {
     test('returns the same value if within range', () => {
-      expect(NonPositiveInt.clamp(-5)).toBe(-5);
+      expect(NonPositiveInt.fromNumber(-5)).toBe(-5);
 
-      expect(NonPositiveInt.clamp(0)).toBe(0);
+      expect(NonPositiveInt.fromNumber(0)).toBe(0);
 
-      expect(NonPositiveInt.clamp(-1000)).toBe(-1000);
+      expect(NonPositiveInt.fromNumber(-1000)).toBe(-1000);
     });
 
     test('clamps positive values to MAX_VALUE (0)', () => {
-      expect(NonPositiveInt.clamp(5)).toBe(0);
+      expect(NonPositiveInt.fromNumber(5)).toBe(0);
 
-      expect(NonPositiveInt.clamp(1000)).toBe(0);
+      expect(NonPositiveInt.fromNumber(1000)).toBe(0);
     });
 
     test('clamps -Infinity to the lower bound', () => {
-      expect(NonPositiveInt.clamp(Number.NEGATIVE_INFINITY)).toBe(
+      expect(NonPositiveInt.fromNumber(Number.NEGATIVE_INFINITY)).toBe(
         -Number.MAX_VALUE,
       );
     });

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

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

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

@@ -163,23 +163,23 @@ describe('NonPositiveSafeInt test', () => {
     });
   });
 
-  describe('NonPositiveSafeInt.clamp', () => {
+  describe('NonPositiveSafeInt.fromNumber', () => {
     test('returns the same value if within range', () => {
-      expect(NonPositiveSafeInt.clamp(-5)).toBe(-5);
+      expect(NonPositiveSafeInt.fromNumber(-5)).toBe(-5);
 
-      expect(NonPositiveSafeInt.clamp(0)).toBe(0);
+      expect(NonPositiveSafeInt.fromNumber(0)).toBe(0);
 
-      expect(NonPositiveSafeInt.clamp(-1000)).toBe(-1000);
+      expect(NonPositiveSafeInt.fromNumber(-1000)).toBe(-1000);
     });
 
     test('clamps positive values to MAX_VALUE (0)', () => {
-      expect(NonPositiveSafeInt.clamp(5)).toBe(0);
+      expect(NonPositiveSafeInt.fromNumber(5)).toBe(0);
 
-      expect(NonPositiveSafeInt.clamp(1000)).toBe(0);
+      expect(NonPositiveSafeInt.fromNumber(1000)).toBe(0);
     });
 
     test('clamps out-of-range negative values to MIN_VALUE', () => {
-      expect(NonPositiveSafeInt.clamp(Number.MIN_SAFE_INTEGER - 1)).toBe(
+      expect(NonPositiveSafeInt.fromNumber(Number.MIN_SAFE_INTEGER - 1)).toBe(
         Number.MIN_SAFE_INTEGER,
       );
     });

package/src/number/branded-types/non-zero-int16.mts

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

package/src/number/branded-types/non-zero-int32.mts

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