ts-data-forge 11.0.1 → 12.1.0

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

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

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

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

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

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

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

@@ -16,8 +16,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -117,7 +117,10 @@ export const PositiveFiniteNumber = {
   is,
 
   /**
-   * The smallest value representable as `PositiveFiniteNumber`.
+   * The smallest value representable as `PositiveFiniteNumber` (the lower
+   * saturation target of `fromNumber`). The domain is open at `0` (excluded),
+   * so this is `Number.MIN_VALUE` — the smallest positive double — rather than
+   * `0`.
    */
   MIN_VALUE,
 
@@ -138,13 +141,17 @@ export const PositiveFiniteNumber = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `PositiveFiniteNumber` range `[MIN_VALUE,
-   * MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `PositiveFiniteNumber`, saturating it
+   * into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value - The value to clamp
-   * @returns The clamped value as a `PositiveFiniteNumber`
+   * Unlike `asPositiveFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `PositiveFiniteNumber` instead of
+   * throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `PositiveFiniteNumber`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Returns the greatest integer less than or equal to a positive finite

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

@@ -12,8 +12,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -106,7 +106,8 @@ export const PositiveInt = {
   is,
 
   /**
-   * The smallest value representable as `PositiveInt`.
+   * The smallest value representable as `PositiveInt` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
 
@@ -151,25 +152,29 @@ export const PositiveInt = {
   max: max_,
 
   /**
-   * Clamps a `number` into the `PositiveInt` range, rounding to the nearest
-   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+   * Converts an arbitrary `number` into a `PositiveInt`, rounding to the
+   * nearest integer and saturating the result into the range `[MIN_VALUE,
+   * MAX_VALUE]`.
+   *
+   * Unlike `asPositiveInt`, this is total: out-of-range inputs are clamped to
+   * the nearest representable `PositiveInt` instead of throwing.
    *
    * @example
    *
    * ```ts
-   * const belowRange = PositiveInt.clamp(0);
+   * const belowRange = PositiveInt.fromNumber(0);
    *
-   * const withinRange = PositiveInt.clamp(10);
+   * const withinRange = PositiveInt.fromNumber(10);
    *
    * assert.isTrue(belowRange === 1);
    *
    * assert.isTrue(withinRange === 10);
    * ```
    *
-   * @param value - The value to clamp
-   * @returns The clamped value as a `PositiveInt`
+   * @param value - The value to convert
+   * @returns The value as a `PositiveInt`
    */
-  clamp,
+  fromNumber,
 
   /**
    * Generates a random `PositiveInt` within the given range.

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.