ts-data-forge 11.0.1 → 12.0.0

package/dist/number/branded-types/negative-safe-int.mjs

@@ -7,7 +7,7 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -21,7 +21,7 @@ const {
   MAX_VALUE: -1,
   typeNameInMessage
 });
-const abs = (x) => PositiveSafeInt.clamp(Math.abs(x));
+const abs = (x) => PositiveSafeInt.fromNumber(Math.abs(x));
 const isNegativeSafeInt = is;
 const asNegativeSafeInt = castType;
 const NegativeSafeInt = {
@@ -34,11 +34,13 @@ 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,
   /**
@@ -65,13 +67,17 @@ 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/dist/number/branded-types/negative-safe-int.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"negative-safe-int.mjs","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"sourcesContent":["import {\n  type NegativeSafeInt as TtfImported_NegativeSafeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveSafeInt } from './positive-safe-int.mjs';\n\nexport type NegativeSafeInt = TtfImported_NegativeSafeInt;\n\ntype ElementType = NegativeSafeInt;\n\nconst typeNameInMessage = 'a negative safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  -1\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\nconst abs = (x: WithSmallInt<ElementType>): PositiveSafeInt =>\n  PositiveSafeInt.clamp(Math.abs(x));\n\n/**\n * Type guard that checks if a value is a negative safe integer.\n *\n * Returns `true` for a negative safe integer — a value with no fractional\n * component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a negative safe integer, `false` otherwise\n */\nexport const isNegativeSafeInt = is;\n\n/**\n * Casts a `number` to the `NegativeSafeInt` branded type.\n *\n * Validates that the value is a negative safe integer and returns it with the\n * `NegativeSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NegativeSafeInt`\n * @throws {TypeError} If the value is not a negative safe integer\n */\nexport const asNegativeSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NegativeSafeInt` branded\n * type.\n *\n * The `NegativeSafeInt` type represents a negative safe integer. Division\n * (`div`) uses floor division.\n */\nexport const NegativeSafeInt = {\n  /**\n   * Type guard that checks if a value is a negative safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a negative safe integer, `false` otherwise\n   * @see {@link isNegativeSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NegativeSafeInt`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NegativeSafeInt`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative safe integer.\n   *\n   * The result is non-negative and keeps the `NegativeSafeInt` brand.\n   *\n   * @param a - The negative safe integer value\n   * @returns The absolute value as a non-negative `NegativeSafeInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given negative safe integers.\n   *\n   * @param values - The negative safe integers to compare (at least one required)\n   * @returns The smallest value as a `NegativeSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given negative safe integers.\n   *\n   * @param values - The negative safe integers to compare (at least one required)\n   * @returns The largest value as a `NegativeSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NegativeSafeInt` range, rounding to the nearest\n   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NegativeSafeInt`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NegativeSafeInt` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NegativeSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeSafeInt`\n   * (floored to an integer).\n   *\n   * @param a - The base negative safe integer\n   * @param b - The exponent negative safe integer\n   * @returns `a ** b` as a `NegativeSafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two negative safe integers, returning `a + b` as a `NegativeSafeInt`.\n   *\n   * @param a - The first negative safe integer\n   * @param b - The second negative safe integer\n   * @returns The sum of `a` and `b` as a `NegativeSafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two negative safe integers, returning `a - b` as a\n   * `NegativeSafeInt`.\n   *\n   * @param a - The first negative safe integer\n   * @param b - The second negative safe integer\n   * @returns The difference of `a` and `b` as a `NegativeSafeInt`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,MAAM,iBAAA,GAAoB,yBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAEV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,eAAA,CAAgB,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAW5B,MAAM,iBAAA,GAAoB;AAY1B,MAAM,iBAAA,GAAoB;AAS1B,MAAM,eAAA,GAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7B,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}
+{"version":3,"file":"negative-safe-int.mjs","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"sourcesContent":["import {\n  type NegativeSafeInt as TtfImported_NegativeSafeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveSafeInt } from './positive-safe-int.mjs';\n\nexport type NegativeSafeInt = TtfImported_NegativeSafeInt;\n\ntype ElementType = NegativeSafeInt;\n\nconst typeNameInMessage = 'a negative safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  -1\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\nconst abs = (x: WithSmallInt<ElementType>): PositiveSafeInt =>\n  PositiveSafeInt.fromNumber(Math.abs(x));\n\n/**\n * Type guard that checks if a value is a negative safe integer.\n *\n * Returns `true` for a negative safe integer — a value with no fractional\n * component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a negative safe integer, `false` otherwise\n */\nexport const isNegativeSafeInt = is;\n\n/**\n * Casts a `number` to the `NegativeSafeInt` branded type.\n *\n * Validates that the value is a negative safe integer and returns it with the\n * `NegativeSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NegativeSafeInt`\n * @throws {TypeError} If the value is not a negative safe integer\n */\nexport const asNegativeSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NegativeSafeInt` branded\n * type.\n *\n * The `NegativeSafeInt` type represents a negative safe integer. Division\n * (`div`) uses floor division.\n */\nexport const NegativeSafeInt = {\n  /**\n   * Type guard that checks if a value is a negative safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a negative safe integer, `false` otherwise\n   * @see {@link isNegativeSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NegativeSafeInt` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NegativeSafeInt` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative safe integer.\n   *\n   * The result is non-negative and keeps the `NegativeSafeInt` brand.\n   *\n   * @param a - The negative safe integer value\n   * @returns The absolute value as a non-negative `NegativeSafeInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given negative safe integers.\n   *\n   * @param values - The negative safe integers to compare (at least one required)\n   * @returns The smallest value as a `NegativeSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given negative safe integers.\n   *\n   * @param values - The negative safe integers to compare (at least one required)\n   * @returns The largest value as a `NegativeSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NegativeSafeInt`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNegativeSafeInt`, this is total: out-of-range inputs are clamped\n   * to the nearest representable `NegativeSafeInt` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NegativeSafeInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NegativeSafeInt` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NegativeSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeSafeInt`\n   * (floored to an integer).\n   *\n   * @param a - The base negative safe integer\n   * @param b - The exponent negative safe integer\n   * @returns `a ** b` as a `NegativeSafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two negative safe integers, returning `a + b` as a `NegativeSafeInt`.\n   *\n   * @param a - The first negative safe integer\n   * @param b - The second negative safe integer\n   * @returns The sum of `a` and `b` as a `NegativeSafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two negative safe integers, returning `a - b` as a\n   * `NegativeSafeInt`.\n   *\n   * @param a - The first negative safe integer\n   * @param b - The second negative safe integer\n   * @returns The difference of `a` and `b` as a `NegativeSafeInt`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,MAAM,iBAAA,GAAoB,yBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAEV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,eAAA,CAAgB,WAAW,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAWjC,MAAM,iBAAA,GAAoB;AAY1B,MAAM,iBAAA,GAAoB;AAS1B,MAAM,eAAA,GAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}

package/dist/number/branded-types/non-negative-finite-number.d.mts

@@ -49,7 +49,8 @@ export declare const NonNegativeFiniteNumber: {
      */
     readonly is: (a: number) => a is TtfImported_NonNegativeFiniteNumber;
     /**
-     * The smallest value representable as `NonNegativeFiniteNumber`.
+     * The smallest value representable as `NonNegativeFiniteNumber` (the lower
+     * saturation target of `fromNumber`).
      */
     readonly MIN_VALUE: 0;
     /**
@@ -67,13 +68,17 @@ export declare const NonNegativeFiniteNumber: {
      */
     readonly max: (...values: readonly TtfImported_NonNegativeFiniteNumber[]) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * 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`
      */
-    readonly clamp: (x: number) => TtfImported_NonNegativeFiniteNumber;
+    readonly fromNumber: (x: number) => TtfImported_NonNegativeFiniteNumber;
     /**
      * Returns the greatest integer less than or equal to a non-negative finite
      * number.

package/dist/number/branded-types/non-negative-finite-number.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"non-negative-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,uBAAuB,IAAI,mCAAmC,EAEpE,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AAiD3C;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;wBAhGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAkG3D;;;;;;OAMG;uBAnGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAqG3D;;;;;;OAMG;wBAtGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAwG3D;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"non-negative-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,uBAAuB,IAAI,mCAAmC,EAEpE,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AAiD3C;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;OAMG;wBArGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAuG3D;;;;;;OAMG;uBAxGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IA0G3D;;;;;;OAMG;wBA3GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IA6G3D;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/non-negative-finite-number.mjs

@@ -5,8 +5,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -43,7 +43,8 @@ const NonNegativeFiniteNumber = {
    */
   is,
   /**
-   * The smallest value representable as `NonNegativeFiniteNumber`.
+   * The smallest value representable as `NonNegativeFiniteNumber` (the lower
+   * saturation target of `fromNumber`).
    */
   MIN_VALUE,
   /**
@@ -61,13 +62,17 @@ 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
    * number.

package/dist/number/branded-types/non-negative-finite-number.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"non-negative-finite-number.mjs","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"sourcesContent":["import {\n  type NonNegativeFiniteNumber as TtfImported_NonNegativeFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeFiniteNumber = TtfImported_NonNegativeFiniteNumber;\n\ntype ElementType = NonNegativeFiniteNumber;\n\nconst typeNameInMessage = 'a non-negative finite number';\n\nconst {\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  0,\n  number\n>({\n  MIN_VALUE: 0,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nexpectType<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Uint>(\n  '=',\n);\n\n/**\n * Type guard that checks if a value is a non-negative finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative finite number, `false` otherwise\n */\nexport const isNonNegativeFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonNegativeFiniteNumber` branded type.\n *\n * Validates that the value is a non-negative finite number and returns it with\n * the `NonNegativeFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeFiniteNumber`\n * @throws {TypeError} If the value is not a non-negative finite number\n */\nexport const asNonNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeFiniteNumber`\n * branded type.\n *\n * The `NonNegativeFiniteNumber` type represents a non-negative finite number.\n */\nexport const NonNegativeFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-negative finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative finite number, `false` otherwise\n   * @see {@link isNonNegativeFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeFiniteNumber`.\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative finite numbers.\n   *\n   * @param values - The non-negative finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative finite numbers.\n   *\n   * @param values - The non-negative finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonNegativeFiniteNumber` range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NonNegativeFiniteNumber`\n   */\n  clamp,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-negative finite\n   * number.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a non-negative finite\n   * number.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-negative finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonNegativeFiniteNumber` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonNegativeFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The base non-negative finite number\n   * @param b - The exponent non-negative finite number\n   * @returns `a ** b` as a `NonNegativeFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative finite numbers, returning `a + b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The sum of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative finite numbers, returning `a - b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The difference of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative finite numbers, returning `a * b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The product of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative finite numbers, returning `a / b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `NonNegativeFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,CAAA;AAAA,EACX,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAeP,MAAM,yBAAA,GAA4B;AAYlC,MAAM,yBAAA,GAA4B;AAQlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}
+{"version":3,"file":"non-negative-finite-number.mjs","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"sourcesContent":["import {\n  type NonNegativeFiniteNumber as TtfImported_NonNegativeFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeFiniteNumber = TtfImported_NonNegativeFiniteNumber;\n\ntype ElementType = NonNegativeFiniteNumber;\n\nconst typeNameInMessage = 'a non-negative finite number';\n\nconst {\n  MIN_VALUE,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  0,\n  number\n>({\n  MIN_VALUE: 0,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nexpectType<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Uint>(\n  '=',\n);\n\n/**\n * Type guard that checks if a value is a non-negative finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative finite number, `false` otherwise\n */\nexport const isNonNegativeFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonNegativeFiniteNumber` branded type.\n *\n * Validates that the value is a non-negative finite number and returns it with\n * the `NonNegativeFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeFiniteNumber`\n * @throws {TypeError} If the value is not a non-negative finite number\n */\nexport const asNonNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeFiniteNumber`\n * branded type.\n *\n * The `NonNegativeFiniteNumber` type represents a non-negative finite number.\n */\nexport const NonNegativeFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-negative finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative finite number, `false` otherwise\n   * @see {@link isNonNegativeFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeFiniteNumber` (the lower\n   * saturation target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative finite numbers.\n   *\n   * @param values - The non-negative finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative finite numbers.\n   *\n   * @param values - The non-negative finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonNegativeFiniteNumber`, saturating\n   * it into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asNonNegativeFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `NonNegativeFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonNegativeFiniteNumber`\n   */\n  fromNumber,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-negative finite\n   * number.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a non-negative finite\n   * number.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-negative finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonNegativeFiniteNumber` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonNegativeFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The base non-negative finite number\n   * @param b - The exponent non-negative finite number\n   * @returns `a ** b` as a `NonNegativeFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative finite numbers, returning `a + b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The sum of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative finite numbers, returning `a - b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The difference of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative finite numbers, returning `a * b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The product of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative finite numbers, returning `a / b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `NonNegativeFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,CAAA;AAAA,EACX,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAeP,MAAM,yBAAA,GAA4B;AAYlC,MAAM,yBAAA,GAA4B;AAQlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}

package/dist/number/branded-types/non-negative-int16.d.mts

@@ -54,11 +54,13 @@ export declare const NonNegativeInt16: {
      */
     readonly is: (a: number) => a is TtfImported_NonNegativeInt16;
     /**
-     * The smallest value representable as `NonNegativeInt16`.
+     * The smallest value representable as `NonNegativeInt16` (the lower
+     * saturation target of `fromNumber`).
      */
     readonly MIN_VALUE: 0;
     /**
-     * The largest value representable as `NonNegativeInt16`.
+     * The largest value representable as `NonNegativeInt16` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
@@ -76,13 +78,17 @@ export declare const NonNegativeInt16: {
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>[]) => TtfImported_NonNegativeInt16;
     /**
-     * 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`
      */
-    readonly clamp: (x: number) => TtfImported_NonNegativeInt16;
+    readonly fromNumber: (x: number) => TtfImported_NonNegativeInt16;
     /**
      * Generates a random `NonNegativeInt16` within the given range.
      *

package/dist/number/branded-types/non-negative-int16.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"non-negative-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,IAAI,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAItF,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AA+B5D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,kDAAK,CAAC;AAErC;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;MAAW,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;OAQG;;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"non-negative-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,IAAI,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAItF,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AA+B5D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,kDAAK,CAAC;AAErC;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;MAAW,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;OAQG;;;;;;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/non-negative-int16.mjs

@@ -6,8 +6,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -33,11 +33,13 @@ 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,
   /**
@@ -55,13 +57,17 @@ 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/dist/number/branded-types/non-negative-int16.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"non-negative-int16.mjs","sources":["../../../src/number/branded-types/non-negative-int16.mts"],"sourcesContent":["import { type NonNegativeInt16 as TtfImported_NonNegativeInt16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeInt16 = TtfImported_NonNegativeInt16;\n\ntype ElementType = NonNegativeInt16;\n\nconst typeNameInMessage = 'a non-negative integer in [0, 2^15)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  0,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  MAX_VALUE: 2 ** 15 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative integer in [0, 2^15).\n *\n * Returns `true` for a non-negative integer in [0, 2^15) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative integer in [0, 2^15), `false` otherwise\n */\nexport const isNonNegativeInt16 = is;\n\n/**\n * Casts a `number` to the `NonNegativeInt16` branded type.\n *\n * Validates that the value is a non-negative integer in [0, 2^15) and returns\n * it with the `NonNegativeInt16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeInt16`\n * @throws {TypeError} If the value is not a non-negative integer in [0, 2^15)\n */\nexport const asNonNegativeInt16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeInt16` branded\n * type.\n *\n * The `NonNegativeInt16` type represents a non-negative integer in [0, 2^15).\n * Division (`div`) uses floor division.\n */\nexport const NonNegativeInt16 = {\n  /**\n   * Type guard that checks if a value is a non-negative integer in [0, 2^15).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative integer in [0, 2^15), `false` otherwise\n   * @see {@link isNonNegativeInt16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeInt16`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonNegativeInt16`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeInt16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeInt16`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonNegativeInt16` range, rounding to the\n   * nearest integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NonNegativeInt16`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NonNegativeInt16` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonNegativeInt16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt16`\n   * (floored to an integer).\n   *\n   * @param a - The base non-negative integer\n   * @param b - The exponent non-negative integer\n   * @returns `a ** b` as a `NonNegativeInt16`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt16`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The sum of `a` and `b` as a `NonNegativeInt16`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as a\n   * `NonNegativeInt16`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The difference of `a` and `b` as a `NonNegativeInt16`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as a\n   * `NonNegativeInt16`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The product of `a` and `b` as a `NonNegativeInt16`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the\n   * result is `a / b` rounded toward negative infinity, as a\n   * `NonNegativeInt16`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `NonNegativeInt16`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeInt16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeInt16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,qCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,kBAAA,GAAqB;AAY3B,MAAM,kBAAA,GAAqB;AAS3B,MAAM,gBAAA,GAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9B,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA;AACF;;;;"}
+{"version":3,"file":"non-negative-int16.mjs","sources":["../../../src/number/branded-types/non-negative-int16.mts"],"sourcesContent":["import { type NonNegativeInt16 as TtfImported_NonNegativeInt16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeInt16 = TtfImported_NonNegativeInt16;\n\ntype ElementType = NonNegativeInt16;\n\nconst typeNameInMessage = 'a non-negative integer in [0, 2^15)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  0,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  MAX_VALUE: 2 ** 15 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative integer in [0, 2^15).\n *\n * Returns `true` for a non-negative integer in [0, 2^15) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative integer in [0, 2^15), `false` otherwise\n */\nexport const isNonNegativeInt16 = is;\n\n/**\n * Casts a `number` to the `NonNegativeInt16` branded type.\n *\n * Validates that the value is a non-negative integer in [0, 2^15) and returns\n * it with the `NonNegativeInt16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeInt16`\n * @throws {TypeError} If the value is not a non-negative integer in [0, 2^15)\n */\nexport const asNonNegativeInt16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeInt16` branded\n * type.\n *\n * The `NonNegativeInt16` type represents a non-negative integer in [0, 2^15).\n * Division (`div`) uses floor division.\n */\nexport const NonNegativeInt16 = {\n  /**\n   * Type guard that checks if a value is a non-negative integer in [0, 2^15).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative integer in [0, 2^15), `false` otherwise\n   * @see {@link isNonNegativeInt16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeInt16` (the lower\n   * saturation target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonNegativeInt16` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeInt16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeInt16`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonNegativeInt16`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNonNegativeInt16`, this is total: out-of-range inputs are clamped\n   * to the nearest representable `NonNegativeInt16` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonNegativeInt16`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NonNegativeInt16` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonNegativeInt16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt16`\n   * (floored to an integer).\n   *\n   * @param a - The base non-negative integer\n   * @param b - The exponent non-negative integer\n   * @returns `a ** b` as a `NonNegativeInt16`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt16`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The sum of `a` and `b` as a `NonNegativeInt16`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as a\n   * `NonNegativeInt16`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The difference of `a` and `b` as a `NonNegativeInt16`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as a\n   * `NonNegativeInt16`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The product of `a` and `b` as a `NonNegativeInt16`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the\n   * result is `a / b` rounded toward negative infinity, as a\n   * `NonNegativeInt16`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `NonNegativeInt16`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeInt16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeInt16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,qCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,kBAAA,GAAqB;AAY3B,MAAM,kBAAA,GAAqB;AAS3B,MAAM,gBAAA,GAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA;AACF;;;;"}

package/dist/number/branded-types/non-negative-int32.d.mts

@@ -52,11 +52,13 @@ export declare const NonNegativeInt32: {
      */
     readonly is: (a: number) => a is TtfImported_NonNegativeInt32;
     /**
-     * The smallest value representable as `NonNegativeInt32`.
+     * The smallest value representable as `NonNegativeInt32` (the lower
+     * saturation target of `fromNumber`).
      */
     readonly MIN_VALUE: 0;
     /**
-     * The largest value representable as `NonNegativeInt32`.
+     * The largest value representable as `NonNegativeInt32` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
@@ -74,13 +76,17 @@ export declare const NonNegativeInt32: {
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>[]) => TtfImported_NonNegativeInt32;
     /**
-     * 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`
      */
-    readonly clamp: (x: number) => TtfImported_NonNegativeInt32;
+    readonly fromNumber: (x: number) => TtfImported_NonNegativeInt32;
     /**
      * Generates a random `NonNegativeInt32` within the given range.
      *

package/dist/number/branded-types/non-negative-int32.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"non-negative-int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-int32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,IAAI,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAItF,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AA+B5D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,kDAAK,CAAC;AAErC;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;MAAW,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;OAQG;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"non-negative-int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-int32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,IAAI,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAItF,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AA+B5D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,kDAAK,CAAC;AAErC;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;MAAW,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;OAQG;;;;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/non-negative-int32.mjs

@@ -6,8 +6,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -33,11 +33,13 @@ 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,
   /**
@@ -55,13 +57,17 @@ 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/dist/number/branded-types/non-negative-int32.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"non-negative-int32.mjs","sources":["../../../src/number/branded-types/non-negative-int32.mts"],"sourcesContent":["import { type NonNegativeInt32 as TtfImported_NonNegativeInt32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeInt32 = TtfImported_NonNegativeInt32;\n\ntype ElementType = NonNegativeInt32;\n\nconst typeNameInMessage = 'a non-negative integer in [0, 2^31)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  0,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  MAX_VALUE: 2 ** 31 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative integer in [0, 2^31).\n *\n * Returns `true` for a non-negative integer in [0, 2^31) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise\n */\nexport const isNonNegativeInt32 = is;\n\n/**\n * Casts a `number` to the `NonNegativeInt32` branded type.\n *\n * Validates that the value is a non-negative integer in [0, 2^31) and returns\n * it with the `NonNegativeInt32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeInt32`\n * @throws {TypeError} If the value is not a non-negative integer in [0, 2^31)\n */\nexport const asNonNegativeInt32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeInt32` branded\n * type.\n *\n * The `NonNegativeInt32` type represents a non-negative integer in [0, 2^31).\n * Division (`div`) uses floor division.\n */\nexport const NonNegativeInt32 = {\n  /**\n   * Type guard that checks if a value is a non-negative integer in [0, 2^31).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise\n   * @see {@link isNonNegativeInt32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeInt32`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonNegativeInt32`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeInt32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeInt32`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonNegativeInt32` range, rounding to the\n   * nearest integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NonNegativeInt32`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NonNegativeInt32` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonNegativeInt32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt32`\n   * (floored to an integer).\n   *\n   * @param a - The base non-negative integer\n   * @param b - The exponent non-negative integer\n   * @returns `a ** b` as a `NonNegativeInt32`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The sum of `a` and `b` as a `NonNegativeInt32`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The difference of `a` and `b` as a `NonNegativeInt32`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The product of `a` and `b` as a `NonNegativeInt32`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the\n   * result is `a / b` rounded toward negative infinity, as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `NonNegativeInt32`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeInt32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeInt32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,qCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,kBAAA,GAAqB;AAY3B,MAAM,kBAAA,GAAqB;AAS3B,MAAM,gBAAA,GAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9B,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA;AACF;;;;"}
+{"version":3,"file":"non-negative-int32.mjs","sources":["../../../src/number/branded-types/non-negative-int32.mts"],"sourcesContent":["import { type NonNegativeInt32 as TtfImported_NonNegativeInt32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeInt32 = TtfImported_NonNegativeInt32;\n\ntype ElementType = NonNegativeInt32;\n\nconst typeNameInMessage = 'a non-negative integer in [0, 2^31)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  0,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  MAX_VALUE: 2 ** 31 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative integer in [0, 2^31).\n *\n * Returns `true` for a non-negative integer in [0, 2^31) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise\n */\nexport const isNonNegativeInt32 = is;\n\n/**\n * Casts a `number` to the `NonNegativeInt32` branded type.\n *\n * Validates that the value is a non-negative integer in [0, 2^31) and returns\n * it with the `NonNegativeInt32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeInt32`\n * @throws {TypeError} If the value is not a non-negative integer in [0, 2^31)\n */\nexport const asNonNegativeInt32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeInt32` branded\n * type.\n *\n * The `NonNegativeInt32` type represents a non-negative integer in [0, 2^31).\n * Division (`div`) uses floor division.\n */\nexport const NonNegativeInt32 = {\n  /**\n   * Type guard that checks if a value is a non-negative integer in [0, 2^31).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise\n   * @see {@link isNonNegativeInt32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeInt32` (the lower\n   * saturation target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonNegativeInt32` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeInt32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeInt32`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonNegativeInt32`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNonNegativeInt32`, this is total: out-of-range inputs are clamped\n   * to the nearest representable `NonNegativeInt32` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonNegativeInt32`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NonNegativeInt32` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonNegativeInt32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt32`\n   * (floored to an integer).\n   *\n   * @param a - The base non-negative integer\n   * @param b - The exponent non-negative integer\n   * @returns `a ** b` as a `NonNegativeInt32`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The sum of `a` and `b` as a `NonNegativeInt32`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The difference of `a` and `b` as a `NonNegativeInt32`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The product of `a` and `b` as a `NonNegativeInt32`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the\n   * result is `a / b` rounded toward negative infinity, as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `NonNegativeInt32`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeInt32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeInt32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,qCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,kBAAA,GAAqB;AAY3B,MAAM,kBAAA,GAAqB;AAS3B,MAAM,gBAAA,GAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA;AACF;;;;"}

package/dist/number/branded-types/non-positive-finite-number.d.mts

@@ -49,7 +49,8 @@ export declare const NonPositiveFiniteNumber: {
      */
     readonly is: (a: number) => a is TtfImported_NonPositiveFiniteNumber;
     /**
-     * The largest value representable as `NonPositiveFiniteNumber`.
+     * The largest value representable as `NonPositiveFiniteNumber` (the upper
+     * saturation target of `fromNumber`).
      */
     readonly MAX_VALUE: 0;
     /**
@@ -67,13 +68,17 @@ export declare const NonPositiveFiniteNumber: {
      */
     readonly max: (...values: readonly TtfImported_NonPositiveFiniteNumber[]) => TtfImported_NonPositiveFiniteNumber;
     /**
-     * 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`
      */
-    readonly clamp: (x: number) => TtfImported_NonPositiveFiniteNumber;
+    readonly fromNumber: (x: number) => TtfImported_NonPositiveFiniteNumber;
     /**
      * Returns the greatest integer less than or equal to a non-positive finite
      * number.

package/dist/number/branded-types/non-positive-finite-number.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"non-positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,uBAAuB,IAAI,mCAAmC,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AA2D3C;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;wBA5GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA4GC;;;;;;OAMG;uBAzGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAyGC;;;;;;OAMG;wBAxGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAwGC;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}
+{"version":3,"file":"non-positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,uBAAuB,IAAI,mCAAmC,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AA2D3C;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;OAMG;wBAjHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAiHC;;;;;;OAMG;uBA9GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA8GC;;;;;;OAMG;wBA7GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA6GC;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}

package/dist/number/branded-types/non-positive-finite-number.mjs

@@ -5,7 +5,7 @@ const {
   MAX_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -45,7 +45,8 @@ const NonPositiveFiniteNumber = {
    */
   is,
   /**
-   * The largest value representable as `NonPositiveFiniteNumber`.
+   * The largest value representable as `NonPositiveFiniteNumber` (the upper
+   * saturation target of `fromNumber`).
    */
   MAX_VALUE,
   /**
@@ -63,13 +64,17 @@ 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
    * number.

package/dist/number/branded-types/non-positive-finite-number.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"non-positive-finite-number.mjs","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"sourcesContent":["import { type NonPositiveFiniteNumber as TtfImported_NonPositiveFiniteNumber } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonPositiveFiniteNumber = TtfImported_NonPositiveFiniteNumber;\n\ntype ElementType = NonPositiveFiniteNumber;\n\nconst typeNameInMessage = 'a non-positive finite number';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  0\n>({\n  MIN_VALUE: Number.MAX_VALUE * -1,\n  MAX_VALUE: 0,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\n/**\n * Type guard that checks if a value is a non-positive finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-positive finite number, `false` otherwise\n */\nexport const isNonPositiveFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonPositiveFiniteNumber` branded type.\n *\n * Validates that the value is a non-positive finite number and returns it with\n * the `NonPositiveFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonPositiveFiniteNumber`\n * @throws {TypeError} If the value is not a non-positive finite number\n */\nexport const asNonPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonPositiveFiniteNumber`\n * branded type.\n *\n * The `NonPositiveFiniteNumber` type represents a non-positive finite number.\n */\nexport const NonPositiveFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-positive finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-positive finite number, `false` otherwise\n   * @see {@link isNonPositiveFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The largest value representable as `NonPositiveFiniteNumber`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-positive finite numbers.\n   *\n   * @param values - The non-positive finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonPositiveFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-positive finite numbers.\n   *\n   * @param values - The non-positive finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonPositiveFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonPositiveFiniteNumber` range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NonPositiveFiniteNumber`\n   */\n  clamp,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-positive finite\n   * number.\n   *\n   * @param a - The non-positive finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a non-positive finite\n   * number.\n   *\n   * @param a - The non-positive finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-positive finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-positive finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonPositiveFiniteNumber` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonPositiveFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The base non-positive finite number\n   * @param b - The exponent non-positive finite number\n   * @returns `a ** b` as a `NonPositiveFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two non-positive finite numbers, returning `a + b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The first non-positive finite number\n   * @param b - The second non-positive finite number\n   * @returns The sum of `a` and `b` as a `NonPositiveFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two non-positive finite numbers, returning `a - b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The first non-positive finite number\n   * @param b - The second non-positive finite number\n   * @returns The difference of `a` and `b` as a `NonPositiveFiniteNumber`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;AAOA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,OAAO,SAAA,GAAY,EAAA;AAAA,EAC9B,SAAA,EAAW,CAAA;AAAA,EACX;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAIF,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAIb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAaK,MAAM,yBAAA,GAA4B;AAYlC,MAAM,yBAAA,GAA4B;AAQlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}
+{"version":3,"file":"non-positive-finite-number.mjs","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"sourcesContent":["import { type NonPositiveFiniteNumber as TtfImported_NonPositiveFiniteNumber } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonPositiveFiniteNumber = TtfImported_NonPositiveFiniteNumber;\n\ntype ElementType = NonPositiveFiniteNumber;\n\nconst typeNameInMessage = 'a non-positive finite number';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  0\n>({\n  MIN_VALUE: Number.MAX_VALUE * -1,\n  MAX_VALUE: 0,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\n/**\n * Type guard that checks if a value is a non-positive finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-positive finite number, `false` otherwise\n */\nexport const isNonPositiveFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonPositiveFiniteNumber` branded type.\n *\n * Validates that the value is a non-positive finite number and returns it with\n * the `NonPositiveFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonPositiveFiniteNumber`\n * @throws {TypeError} If the value is not a non-positive finite number\n */\nexport const asNonPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonPositiveFiniteNumber`\n * branded type.\n *\n * The `NonPositiveFiniteNumber` type represents a non-positive finite number.\n */\nexport const NonPositiveFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-positive finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-positive finite number, `false` otherwise\n   * @see {@link isNonPositiveFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The largest value representable as `NonPositiveFiniteNumber` (the upper\n   * saturation target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-positive finite numbers.\n   *\n   * @param values - The non-positive finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonPositiveFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-positive finite numbers.\n   *\n   * @param values - The non-positive finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonPositiveFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonPositiveFiniteNumber`, saturating\n   * it into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asNonPositiveFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `NonPositiveFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonPositiveFiniteNumber`\n   */\n  fromNumber,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-positive finite\n   * number.\n   *\n   * @param a - The non-positive finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a non-positive finite\n   * number.\n   *\n   * @param a - The non-positive finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-positive finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-positive finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonPositiveFiniteNumber` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonPositiveFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The base non-positive finite number\n   * @param b - The exponent non-positive finite number\n   * @returns `a ** b` as a `NonPositiveFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two non-positive finite numbers, returning `a + b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The first non-positive finite number\n   * @param b - The second non-positive finite number\n   * @returns The sum of `a` and `b` as a `NonPositiveFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two non-positive finite numbers, returning `a - b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The first non-positive finite number\n   * @param b - The second non-positive finite number\n   * @returns The difference of `a` and `b` as a `NonPositiveFiniteNumber`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;AAOA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,OAAO,SAAA,GAAY,EAAA;AAAA,EAC9B,SAAA,EAAW,CAAA;AAAA,EACX;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAIF,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAIb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAaK,MAAM,yBAAA,GAA4B;AAYlC,MAAM,yBAAA,GAA4B;AAQlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}