ts-data-forge 11.0.1 → 12.1.0

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

@@ -6,8 +6,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -46,11 +46,13 @@ 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,
   /**
@@ -90,17 +92,21 @@ 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);
    *
@@ -109,10 +115,10 @@ 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/dist/number/branded-types/positive-safe-int.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"positive-safe-int.mjs","sources":["../../../src/number/branded-types/positive-safe-int.mts"],"sourcesContent":["import {\n  type SafeUint,\n  type PositiveSafeInt as TtfImported_PositiveSafeInt,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveSafeInt = TtfImported_PositiveSafeInt;\n\ntype ElementType = PositiveSafeInt;\n\nconst typeNameInMessage = 'a positive safe integer';\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  1,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 1,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive safe integer.\n *\n * Returns `true` for a positive safe integer — a value with no fractional\n * component.\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isPositiveSafeInt(1));\n *\n * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));\n *\n * assert.isFalse(isPositiveSafeInt(0));\n *\n * assert.isTrue(PositiveSafeInt.is(42));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive safe integer, `false` otherwise\n */\nexport const isPositiveSafeInt = is;\n\n/**\n * Casts a `number` to the `PositiveSafeInt` branded type.\n *\n * Validates that the value is a positive safe integer and returns it with the\n * `PositiveSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asPositiveSafeInt(128);\n *\n * assert.isTrue(branded === 128);\n *\n * assert.isTrue(PositiveSafeInt.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveSafeInt`\n * @throws {TypeError} If the value is not a positive safe integer\n */\nexport const asPositiveSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveSafeInt` branded\n * type.\n *\n * The `PositiveSafeInt` type represents a positive safe integer. Division\n * (`div`) uses floor division.\n */\nexport const PositiveSafeInt = {\n  /**\n   * Type guard that checks if a value is a positive safe integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isPositiveSafeInt(1));\n   *\n   * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));\n   *\n   * assert.isFalse(isPositiveSafeInt(0));\n   *\n   * assert.isTrue(PositiveSafeInt.is(42));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive safe integer, `false` otherwise\n   * @see {@link isPositiveSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveSafeInt`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `PositiveSafeInt`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given positive safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = PositiveSafeInt.min(\n   *   asPositiveSafeInt(10),\n   *   asPositiveSafeInt(5),\n   * );\n   *\n   * assert.isTrue(smallest === 5);\n   * ```\n   *\n   * @param values - The positive safe integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = PositiveSafeInt.max(\n   *   asPositiveSafeInt(10),\n   *   asPositiveSafeInt(5),\n   * );\n   *\n   * assert.isTrue(largest === 10);\n   * ```\n   *\n   * @param values - The positive safe integers to compare (at least one required)\n   * @returns The largest value as a `PositiveSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `PositiveSafeInt` range, rounding to the nearest\n   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @example\n   *\n   * ```ts\n   * const belowRange = PositiveSafeInt.clamp(0);\n   *\n   * const withinRange = PositiveSafeInt.clamp(123);\n   *\n   * const aboveRange = PositiveSafeInt.clamp(Number.MAX_SAFE_INTEGER + 10);\n   *\n   * assert.isTrue(belowRange === 1);\n   *\n   * assert.isTrue(withinRange === 123);\n   *\n   * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);\n   * ```\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `PositiveSafeInt`\n   */\n  clamp,\n\n  /**\n   * Generates a random `PositiveSafeInt` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asPositiveSafeInt(1);\n   *\n   * const max = asPositiveSafeInt(6);\n   *\n   * const randomValue = PositiveSafeInt.random(min, max);\n   *\n   * assert.isTrue(PositiveSafeInt.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= 1 && randomValue <= 6);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `PositiveSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveSafeInt`\n   * (floored to an integer).\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asPositiveSafeInt(3);\n   *\n   * const exponent = asPositiveSafeInt(3);\n   *\n   * const power = PositiveSafeInt.pow(base, exponent);\n   *\n   * assert.isTrue(power === 27);\n   * ```\n   *\n   * @param a - The base positive safe integer\n   * @param b - The exponent positive safe integer\n   * @returns `a ** b` as a `PositiveSafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two positive safe integers, returning `a + b` as a `PositiveSafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = PositiveSafeInt.add(\n   *   asPositiveSafeInt(1000),\n   *   asPositiveSafeInt(2048),\n   * );\n   *\n   * assert.isTrue(sum === 3048);\n   *\n   * assert.isTrue(PositiveSafeInt.is(sum));\n   * ```\n   *\n   * @param a - The first positive safe integer\n   * @param b - The second positive safe integer\n   * @returns The sum of `a` and `b` as a `PositiveSafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two positive safe integers, returning `a - b` as a\n   * `PositiveSafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = PositiveSafeInt.sub(\n   *   asPositiveSafeInt(10),\n   *   asPositiveSafeInt(20),\n   * );\n   *\n   * assert.isTrue(difference === 1);\n   *\n   * assert.isTrue(PositiveSafeInt.is(difference));\n   * ```\n   *\n   * @param a - The first positive safe integer\n   * @param b - The second positive safe integer\n   * @returns The difference of `a` and `b` as a `PositiveSafeInt`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive safe integers, returning `a * b` as a\n   * `PositiveSafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = PositiveSafeInt.mul(\n   *   asPositiveSafeInt(50),\n   *   asPositiveSafeInt(20),\n   * );\n   *\n   * assert.isTrue(product === 1000);\n   *\n   * assert.isTrue(PositiveSafeInt.is(product));\n   * ```\n   *\n   * @param a - The first positive safe integer\n   * @param b - The second positive safe integer\n   * @returns The product of `a` and `b` as a `PositiveSafeInt`\n   */\n  mul,\n\n  /**\n   * Divides two positive safe integers using floor division (`⌊a / b⌋`): the\n   * result is `a / b` rounded toward negative infinity, as a `PositiveSafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = PositiveSafeInt.div(\n   *   asPositiveSafeInt(25),\n   *   asPositiveSafeInt(4),\n   * );\n   *\n   * const clamped = PositiveSafeInt.div(\n   *   asPositiveSafeInt(5),\n   *   asPositiveSafeInt(50),\n   * );\n   *\n   * assert.isTrue(quotient === 6);\n   *\n   * assert.isTrue(clamped === 1);\n   * ```\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `PositiveSafeInt`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveSafeInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveSafeInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('<=');\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,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;AAAA,EAEX,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAuBH,MAAM,iBAAA,GAAoB;AAsB1B,MAAM,iBAAA,GAAoB;AAS1B,MAAM,eAAA,GAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB7B,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4BA;AACF;;;;"}
+{"version":3,"file":"positive-safe-int.mjs","sources":["../../../src/number/branded-types/positive-safe-int.mts"],"sourcesContent":["import {\n  type SafeUint,\n  type PositiveSafeInt as TtfImported_PositiveSafeInt,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveSafeInt = TtfImported_PositiveSafeInt;\n\ntype ElementType = PositiveSafeInt;\n\nconst typeNameInMessage = 'a positive safe integer';\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  1,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 1,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive safe integer.\n *\n * Returns `true` for a positive safe integer — a value with no fractional\n * component.\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isPositiveSafeInt(1));\n *\n * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));\n *\n * assert.isFalse(isPositiveSafeInt(0));\n *\n * assert.isTrue(PositiveSafeInt.is(42));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive safe integer, `false` otherwise\n */\nexport const isPositiveSafeInt = is;\n\n/**\n * Casts a `number` to the `PositiveSafeInt` branded type.\n *\n * Validates that the value is a positive safe integer and returns it with the\n * `PositiveSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asPositiveSafeInt(128);\n *\n * assert.isTrue(branded === 128);\n *\n * assert.isTrue(PositiveSafeInt.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveSafeInt`\n * @throws {TypeError} If the value is not a positive safe integer\n */\nexport const asPositiveSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveSafeInt` branded\n * type.\n *\n * The `PositiveSafeInt` type represents a positive safe integer. Division\n * (`div`) uses floor division.\n */\nexport const PositiveSafeInt = {\n  /**\n   * Type guard that checks if a value is a positive safe integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isPositiveSafeInt(1));\n   *\n   * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));\n   *\n   * assert.isFalse(isPositiveSafeInt(0));\n   *\n   * assert.isTrue(PositiveSafeInt.is(42));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive safe integer, `false` otherwise\n   * @see {@link isPositiveSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveSafeInt` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `PositiveSafeInt` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given positive safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = PositiveSafeInt.min(\n   *   asPositiveSafeInt(10),\n   *   asPositiveSafeInt(5),\n   * );\n   *\n   * assert.isTrue(smallest === 5);\n   * ```\n   *\n   * @param values - The positive safe integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = PositiveSafeInt.max(\n   *   asPositiveSafeInt(10),\n   *   asPositiveSafeInt(5),\n   * );\n   *\n   * assert.isTrue(largest === 10);\n   * ```\n   *\n   * @param values - The positive safe integers to compare (at least one required)\n   * @returns The largest value as a `PositiveSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `PositiveSafeInt`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asPositiveSafeInt`, this is total: out-of-range inputs are clamped\n   * to the nearest representable `PositiveSafeInt` instead of throwing.\n   *\n   * @example\n   *\n   * ```ts\n   * const belowRange = PositiveSafeInt.fromNumber(0);\n   *\n   * const withinRange = PositiveSafeInt.fromNumber(123);\n   *\n   * const aboveRange = PositiveSafeInt.fromNumber(Number.MAX_SAFE_INTEGER + 10);\n   *\n   * assert.isTrue(belowRange === 1);\n   *\n   * assert.isTrue(withinRange === 123);\n   *\n   * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);\n   * ```\n   *\n   * @param value - The value to convert\n   * @returns The value as a `PositiveSafeInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `PositiveSafeInt` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asPositiveSafeInt(1);\n   *\n   * const max = asPositiveSafeInt(6);\n   *\n   * const randomValue = PositiveSafeInt.random(min, max);\n   *\n   * assert.isTrue(PositiveSafeInt.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= 1 && randomValue <= 6);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `PositiveSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveSafeInt`\n   * (floored to an integer).\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asPositiveSafeInt(3);\n   *\n   * const exponent = asPositiveSafeInt(3);\n   *\n   * const power = PositiveSafeInt.pow(base, exponent);\n   *\n   * assert.isTrue(power === 27);\n   * ```\n   *\n   * @param a - The base positive safe integer\n   * @param b - The exponent positive safe integer\n   * @returns `a ** b` as a `PositiveSafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two positive safe integers, returning `a + b` as a `PositiveSafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = PositiveSafeInt.add(\n   *   asPositiveSafeInt(1000),\n   *   asPositiveSafeInt(2048),\n   * );\n   *\n   * assert.isTrue(sum === 3048);\n   *\n   * assert.isTrue(PositiveSafeInt.is(sum));\n   * ```\n   *\n   * @param a - The first positive safe integer\n   * @param b - The second positive safe integer\n   * @returns The sum of `a` and `b` as a `PositiveSafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two positive safe integers, returning `a - b` as a\n   * `PositiveSafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = PositiveSafeInt.sub(\n   *   asPositiveSafeInt(10),\n   *   asPositiveSafeInt(20),\n   * );\n   *\n   * assert.isTrue(difference === 1);\n   *\n   * assert.isTrue(PositiveSafeInt.is(difference));\n   * ```\n   *\n   * @param a - The first positive safe integer\n   * @param b - The second positive safe integer\n   * @returns The difference of `a` and `b` as a `PositiveSafeInt`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive safe integers, returning `a * b` as a\n   * `PositiveSafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = PositiveSafeInt.mul(\n   *   asPositiveSafeInt(50),\n   *   asPositiveSafeInt(20),\n   * );\n   *\n   * assert.isTrue(product === 1000);\n   *\n   * assert.isTrue(PositiveSafeInt.is(product));\n   * ```\n   *\n   * @param a - The first positive safe integer\n   * @param b - The second positive safe integer\n   * @returns The product of `a` and `b` as a `PositiveSafeInt`\n   */\n  mul,\n\n  /**\n   * Divides two positive safe integers using floor division (`⌊a / b⌋`): the\n   * result is `a / b` rounded toward negative infinity, as a `PositiveSafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = PositiveSafeInt.div(\n   *   asPositiveSafeInt(25),\n   *   asPositiveSafeInt(4),\n   * );\n   *\n   * const clamped = PositiveSafeInt.div(\n   *   asPositiveSafeInt(5),\n   *   asPositiveSafeInt(50),\n   * );\n   *\n   * assert.isTrue(quotient === 6);\n   *\n   * assert.isTrue(clamped === 1);\n   * ```\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `PositiveSafeInt`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveSafeInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveSafeInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,yBAAA;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;AAAA,EAEX,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAuBH,MAAM,iBAAA,GAAoB;AAsB1B,MAAM,iBAAA,GAAoB;AAS1B,MAAM,eAAA,GAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoB7B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6BL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4BA;AACF;;;;"}

package/dist/number/branded-types/positive-uint16.d.mts

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

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

@@ -1 +1 @@
-{"version":3,"file":"positive-uint16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-uint16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,IAAI,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAIlF,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AA+BxD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;MAAW,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-uint16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-uint16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,IAAI,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAIlF,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AA+BxD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;MAAW,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/positive-uint16.mjs

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

@@ -1 +1 @@
-{"version":3,"file":"positive-uint16.mjs","sources":["../../../src/number/branded-types/positive-uint16.mts"],"sourcesContent":["import { type PositiveUint16 as TtfImported_PositiveUint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveUint16 = TtfImported_PositiveUint16;\n\ntype ElementType = PositiveUint16;\n\nconst typeNameInMessage = 'a positive integer in [1, 2^16)';\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  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 1,\n  MAX_VALUE: 2 ** 16 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive integer in [1, 2^16).\n *\n * Returns `true` for a positive integer in [1, 2^16) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive integer in [1, 2^16), `false` otherwise\n */\nexport const isPositiveUint16 = is;\n\n/**\n * Casts a `number` to the `PositiveUint16` branded type.\n *\n * Validates that the value is a positive integer in [1, 2^16) and returns it\n * with the `PositiveUint16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveUint16`\n * @throws {TypeError} If the value is not a positive integer in [1, 2^16)\n */\nexport const asPositiveUint16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveUint16` branded\n * type.\n *\n * The `PositiveUint16` type represents a positive integer in [1, 2^16).\n * Division (`div`) uses floor division.\n */\nexport const PositiveUint16 = {\n  /**\n   * Type guard that checks if a value is a positive integer in [1, 2^16).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive integer in [1, 2^16), `false` otherwise\n   * @see {@link isPositiveUint16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveUint16`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `PositiveUint16`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveUint16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The largest value as a `PositiveUint16`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `PositiveUint16` 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 `PositiveUint16`\n   */\n  clamp,\n\n  /**\n   * Generates a random `PositiveUint16` 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 `PositiveUint16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveUint16`\n   * (floored to an integer).\n   *\n   * @param a - The base positive integer\n   * @param b - The exponent positive integer\n   * @returns `a ** b` as a `PositiveUint16`\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, returning `a + b` as a `PositiveUint16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The sum of `a` and `b` as a `PositiveUint16`\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, returning `a - b` as a `PositiveUint16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The difference of `a` and `b` as a `PositiveUint16`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, returning `a * b` as a `PositiveUint16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The product of `a` and `b` as a `PositiveUint16`\n   */\n  mul,\n\n  /**\n   * Divides two positive integers using floor division (`⌊a / b⌋`): the result\n   * is `a / b` rounded toward negative infinity, as a `PositiveUint16`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `PositiveUint16`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveUint16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveUint16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,iCAAA;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,gBAAA,GAAmB;AAYzB,MAAM,gBAAA,GAAmB;AASzB,MAAM,cAAA,GAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5B,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,EASA,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":"positive-uint16.mjs","sources":["../../../src/number/branded-types/positive-uint16.mts"],"sourcesContent":["import { type PositiveUint16 as TtfImported_PositiveUint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveUint16 = TtfImported_PositiveUint16;\n\ntype ElementType = PositiveUint16;\n\nconst typeNameInMessage = 'a positive integer in [1, 2^16)';\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  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 1,\n  MAX_VALUE: 2 ** 16 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive integer in [1, 2^16).\n *\n * Returns `true` for a positive integer in [1, 2^16) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive integer in [1, 2^16), `false` otherwise\n */\nexport const isPositiveUint16 = is;\n\n/**\n * Casts a `number` to the `PositiveUint16` branded type.\n *\n * Validates that the value is a positive integer in [1, 2^16) and returns it\n * with the `PositiveUint16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveUint16`\n * @throws {TypeError} If the value is not a positive integer in [1, 2^16)\n */\nexport const asPositiveUint16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveUint16` branded\n * type.\n *\n * The `PositiveUint16` type represents a positive integer in [1, 2^16).\n * Division (`div`) uses floor division.\n */\nexport const PositiveUint16 = {\n  /**\n   * Type guard that checks if a value is a positive integer in [1, 2^16).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive integer in [1, 2^16), `false` otherwise\n   * @see {@link isPositiveUint16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveUint16` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `PositiveUint16` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveUint16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The largest value as a `PositiveUint16`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `PositiveUint16`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asPositiveUint16`, this is total: out-of-range inputs are clamped\n   * to the nearest representable `PositiveUint16` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `PositiveUint16`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `PositiveUint16` 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 `PositiveUint16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveUint16`\n   * (floored to an integer).\n   *\n   * @param a - The base positive integer\n   * @param b - The exponent positive integer\n   * @returns `a ** b` as a `PositiveUint16`\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, returning `a + b` as a `PositiveUint16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The sum of `a` and `b` as a `PositiveUint16`\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, returning `a - b` as a `PositiveUint16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The difference of `a` and `b` as a `PositiveUint16`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, returning `a * b` as a `PositiveUint16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The product of `a` and `b` as a `PositiveUint16`\n   */\n  mul,\n\n  /**\n   * Divides two positive integers using floor division (`⌊a / b⌋`): the result\n   * is `a / b` rounded toward negative infinity, as a `PositiveUint16`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `PositiveUint16`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveUint16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveUint16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,iCAAA;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,gBAAA,GAAmB;AAYzB,MAAM,gBAAA,GAAmB;AASzB,MAAM,cAAA,GAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5B,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,EASA,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/positive-uint32.d.mts

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

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

@@ -1 +1 @@
-{"version":3,"file":"positive-uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-uint32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,IAAI,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAIlF,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AA+BxD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;MAAW,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-uint32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,IAAI,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAIlF,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AA+BxD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;MAAW,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/positive-uint32.mjs

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

@@ -1 +1 @@
-{"version":3,"file":"positive-uint32.mjs","sources":["../../../src/number/branded-types/positive-uint32.mts"],"sourcesContent":["import { type PositiveUint32 as TtfImported_PositiveUint32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveUint32 = TtfImported_PositiveUint32;\n\ntype ElementType = PositiveUint32;\n\nconst typeNameInMessage = 'a positive integer in [1, 2^32)';\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  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 1,\n  MAX_VALUE: 2 ** 32 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive integer in [1, 2^32).\n *\n * Returns `true` for a positive integer in [1, 2^32) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive integer in [1, 2^32), `false` otherwise\n */\nexport const isPositiveUint32 = is;\n\n/**\n * Casts a `number` to the `PositiveUint32` branded type.\n *\n * Validates that the value is a positive integer in [1, 2^32) and returns it\n * with the `PositiveUint32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveUint32`\n * @throws {TypeError} If the value is not a positive integer in [1, 2^32)\n */\nexport const asPositiveUint32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveUint32` branded\n * type.\n *\n * The `PositiveUint32` type represents a positive integer in [1, 2^32).\n * Division (`div`) uses floor division.\n */\nexport const PositiveUint32 = {\n  /**\n   * Type guard that checks if a value is a positive integer in [1, 2^32).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive integer in [1, 2^32), `false` otherwise\n   * @see {@link isPositiveUint32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveUint32`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `PositiveUint32`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveUint32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The largest value as a `PositiveUint32`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `PositiveUint32` 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 `PositiveUint32`\n   */\n  clamp,\n\n  /**\n   * Generates a random `PositiveUint32` 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 `PositiveUint32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveUint32`\n   * (floored to an integer).\n   *\n   * @param a - The base positive integer\n   * @param b - The exponent positive integer\n   * @returns `a ** b` as a `PositiveUint32`\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, returning `a + b` as a `PositiveUint32`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The sum of `a` and `b` as a `PositiveUint32`\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, returning `a - b` as a `PositiveUint32`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The difference of `a` and `b` as a `PositiveUint32`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, returning `a * b` as a `PositiveUint32`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The product of `a` and `b` as a `PositiveUint32`\n   */\n  mul,\n\n  /**\n   * Divides two positive integers using floor division (`⌊a / b⌋`): the result\n   * is `a / b` rounded toward negative infinity, as a `PositiveUint32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `PositiveUint32`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveUint32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveUint32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,iCAAA;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,gBAAA,GAAmB;AAYzB,MAAM,gBAAA,GAAmB;AASzB,MAAM,cAAA,GAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5B,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,EASA,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":"positive-uint32.mjs","sources":["../../../src/number/branded-types/positive-uint32.mts"],"sourcesContent":["import { type PositiveUint32 as TtfImported_PositiveUint32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveUint32 = TtfImported_PositiveUint32;\n\ntype ElementType = PositiveUint32;\n\nconst typeNameInMessage = 'a positive integer in [1, 2^32)';\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  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 1,\n  MAX_VALUE: 2 ** 32 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive integer in [1, 2^32).\n *\n * Returns `true` for a positive integer in [1, 2^32) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive integer in [1, 2^32), `false` otherwise\n */\nexport const isPositiveUint32 = is;\n\n/**\n * Casts a `number` to the `PositiveUint32` branded type.\n *\n * Validates that the value is a positive integer in [1, 2^32) and returns it\n * with the `PositiveUint32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveUint32`\n * @throws {TypeError} If the value is not a positive integer in [1, 2^32)\n */\nexport const asPositiveUint32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveUint32` branded\n * type.\n *\n * The `PositiveUint32` type represents a positive integer in [1, 2^32).\n * Division (`div`) uses floor division.\n */\nexport const PositiveUint32 = {\n  /**\n   * Type guard that checks if a value is a positive integer in [1, 2^32).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive integer in [1, 2^32), `false` otherwise\n   * @see {@link isPositiveUint32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveUint32` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `PositiveUint32` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveUint32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The largest value as a `PositiveUint32`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `PositiveUint32`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asPositiveUint32`, this is total: out-of-range inputs are clamped\n   * to the nearest representable `PositiveUint32` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `PositiveUint32`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `PositiveUint32` 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 `PositiveUint32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveUint32`\n   * (floored to an integer).\n   *\n   * @param a - The base positive integer\n   * @param b - The exponent positive integer\n   * @returns `a ** b` as a `PositiveUint32`\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, returning `a + b` as a `PositiveUint32`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The sum of `a` and `b` as a `PositiveUint32`\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, returning `a - b` as a `PositiveUint32`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The difference of `a` and `b` as a `PositiveUint32`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, returning `a * b` as a `PositiveUint32`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The product of `a` and `b` as a `PositiveUint32`\n   */\n  mul,\n\n  /**\n   * Divides two positive integers using floor division (`⌊a / b⌋`): the result\n   * is `a / b` rounded toward negative infinity, as a `PositiveUint32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `PositiveUint32`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveUint32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveUint32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,iCAAA;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,gBAAA,GAAmB;AAYzB,MAAM,gBAAA,GAAmB;AASzB,MAAM,cAAA,GAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5B,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,EASA,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/safe-int.d.mts

@@ -73,11 +73,13 @@ export declare const SafeInt: {
      */
     readonly is: (a: number) => a is TtfImported_SafeInt;
     /**
-     * The smallest value representable as `SafeInt`.
+     * The smallest value representable as `SafeInt` (the lower saturation target
+     * of `fromNumber`).
      */
     readonly MIN_VALUE: TtfImported_SafeInt;
     /**
-     * The largest value representable as `SafeInt`.
+     * The largest value representable as `SafeInt` (the upper saturation target
+     * of `fromNumber`).
      */
     readonly MAX_VALUE: SafeUint;
     /**
@@ -132,17 +134,20 @@ export declare const SafeInt: {
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>[]) => TtfImported_SafeInt;
     /**
-     * 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);
      *
@@ -151,10 +156,10 @@ export declare 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`
      */
-    readonly clamp: (x: number) => TtfImported_SafeInt;
+    readonly fromNumber: (x: number) => TtfImported_SafeInt;
     /**
      * Generates a random `SafeInt` within the given range.
      *

package/dist/number/branded-types/safe-int.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,OAAO,IAAI,mBAAmB,EACpC,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAkC1C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,yCAAK,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS;;;;;;;MAAW,CAAC;AAElC;;;;;GAKG;AACH,eAAO,MAAM,OAAO;IAClB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;OAqBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,OAAO,IAAI,mBAAmB,EACpC,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAkC1C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,yCAAK,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS;;;;;;;MAAW,CAAC;AAElC;;;;;GAKG;AACH,eAAO,MAAM,OAAO;IAClB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;OAqBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;;;;;;;;;CAEK,CAAC"}

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

@@ -7,8 +7,8 @@ const {
   abs,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -46,11 +46,13 @@ 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,
   /**
@@ -105,17 +107,20 @@ 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);
    *
@@ -124,10 +129,10 @@ 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/dist/number/branded-types/safe-int.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"safe-int.mjs","sources":["../../../src/number/branded-types/safe-int.mts"],"sourcesContent":["import {\n  type SafeUint,\n  type SafeInt as TtfImported_SafeInt,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type SafeInt = TtfImported_SafeInt;\n\ntype ElementType = SafeInt;\n\nconst typeNameInMessage = 'a safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  abs,\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  SafeInt,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer\n  MIN_VALUE: Number.MIN_SAFE_INTEGER as SafeInt,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a safe integer.\n *\n * Returns `true` for a safe integer — a value with no fractional component.\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));\n *\n * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));\n *\n * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is a safe integer, `false` otherwise\n */\nexport const isSafeInt = is;\n\n/**\n * Casts a `number` to the `SafeInt` branded type.\n *\n * Validates that the value is a safe integer and returns it with the `SafeInt`\n * brand. Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asSafeInt(123);\n *\n * assert.isTrue(branded === 123);\n *\n * assert.isTrue(SafeInt.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as a `SafeInt`\n * @throws {TypeError} If the value is not a safe integer\n */\nexport const asSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `SafeInt` branded type.\n *\n * The `SafeInt` type represents a safe integer. Division (`div`) uses floor\n * division.\n */\nexport const SafeInt = {\n  /**\n   * Type guard that checks if a value is a safe integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));\n   *\n   * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));\n   *\n   * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a safe integer, `false` otherwise\n   * @see {@link isSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `SafeInt`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `SafeInt`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a safe integer.\n   *\n   * The result is non-negative and keeps the `SafeInt` brand.\n   *\n   * @example\n   *\n   * ```ts\n   * const negative = asSafeInt(-900);\n   *\n   * const absolute = SafeInt.abs(negative);\n   *\n   * assert.isTrue(absolute === 900);\n   *\n   * assert.isTrue(SafeInt.is(absolute));\n   * ```\n   *\n   * @param a - The safe integer value\n   * @returns The absolute value as a non-negative `SafeInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = SafeInt.min(asSafeInt(25), asSafeInt(-14), asSafeInt(99));\n   *\n   * assert.isTrue(smallest === -14);\n   * ```\n   *\n   * @param values - The safe integers to compare (at least one required)\n   * @returns The smallest value as a `SafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = SafeInt.max(asSafeInt(25), asSafeInt(-14), asSafeInt(99));\n   *\n   * assert.isTrue(largest === 99);\n   * ```\n   *\n   * @param values - The safe integers to compare (at least one required)\n   * @returns The largest value as a `SafeInt`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `SafeInt` range, rounding to the nearest integer\n   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @example\n   *\n   * ```ts\n   * const aboveRange = SafeInt.clamp(1e20);\n   *\n   * const withinRange = SafeInt.clamp(123);\n   *\n   * const belowRange = SafeInt.clamp(-1e20);\n   *\n   * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);\n   *\n   * assert.isTrue(withinRange === 123);\n   *\n   * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);\n   * ```\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `SafeInt`\n   */\n  clamp,\n\n  /**\n   * Generates a random `SafeInt` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asSafeInt(-10);\n   *\n   * const max = asSafeInt(10);\n   *\n   * const randomValue = SafeInt.random(min, max);\n   *\n   * assert.isTrue(SafeInt.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= -10 && randomValue <= 10);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `SafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `SafeInt` (floored to\n   * an integer).\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asSafeInt(3);\n   *\n   * const exponent = asSafeInt(5);\n   *\n   * const power = SafeInt.pow(base, exponent);\n   *\n   * assert.isTrue(power === 243);\n   *\n   * assert.isTrue(SafeInt.is(power));\n   * ```\n   *\n   * @param a - The base safe integer\n   * @param b - The exponent safe integer\n   * @returns `a ** b` as a `SafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two safe integers, returning `a + b` as a `SafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = SafeInt.add(asSafeInt(9), asSafeInt(4));\n   *\n   * assert.isTrue(sum === 13);\n   *\n   * assert.isTrue(SafeInt.is(sum));\n   * ```\n   *\n   * @param a - The first safe integer\n   * @param b - The second safe integer\n   * @returns The sum of `a` and `b` as a `SafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two safe integers, returning `a - b` as a `SafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = SafeInt.sub(asSafeInt(9), asSafeInt(14));\n   *\n   * assert.isTrue(difference === -5);\n   *\n   * assert.isTrue(SafeInt.is(difference));\n   * ```\n   *\n   * @param a - The first safe integer\n   * @param b - The second safe integer\n   * @returns The difference of `a` and `b` as a `SafeInt`\n   */\n  sub,\n\n  /**\n   * Multiplies two safe integers, returning `a * b` as a `SafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = SafeInt.mul(asSafeInt(-8), asSafeInt(7));\n   *\n   * assert.isTrue(product === -56);\n   *\n   * assert.isTrue(SafeInt.is(product));\n   * ```\n   *\n   * @param a - The first safe integer\n   * @param b - The second safe integer\n   * @returns The product of `a` and `b` as a `SafeInt`\n   */\n  mul,\n\n  /**\n   * Divides two safe integers using floor division (`⌊a / b⌋`): the result is\n   * `a / b` rounded toward negative infinity, as a `SafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = SafeInt.div(asSafeInt(-17), asSafeInt(5));\n   *\n   * assert.isTrue(quotient === -4);\n   *\n   * assert.isTrue(SafeInt.is(quotient));\n   * ```\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `SafeInt`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof SafeInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof SafeInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,gBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;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;AAAA,EAEtB,WAAW,MAAA,CAAO,gBAAA;AAAA;AAAA,EAElB,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAoBH,MAAM,SAAA,GAAY;AAsBlB,MAAM,SAAA,GAAY;AAQlB,MAAM,OAAA,GAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBrB,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBA;AACF;;;;"}
+{"version":3,"file":"safe-int.mjs","sources":["../../../src/number/branded-types/safe-int.mts"],"sourcesContent":["import {\n  type SafeUint,\n  type SafeInt as TtfImported_SafeInt,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type SafeInt = TtfImported_SafeInt;\n\ntype ElementType = SafeInt;\n\nconst typeNameInMessage = 'a safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  abs,\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  SafeInt,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer\n  MIN_VALUE: Number.MIN_SAFE_INTEGER as SafeInt,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a safe integer.\n *\n * Returns `true` for a safe integer — a value with no fractional component.\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));\n *\n * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));\n *\n * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is a safe integer, `false` otherwise\n */\nexport const isSafeInt = is;\n\n/**\n * Casts a `number` to the `SafeInt` branded type.\n *\n * Validates that the value is a safe integer and returns it with the `SafeInt`\n * brand. Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asSafeInt(123);\n *\n * assert.isTrue(branded === 123);\n *\n * assert.isTrue(SafeInt.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as a `SafeInt`\n * @throws {TypeError} If the value is not a safe integer\n */\nexport const asSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `SafeInt` branded type.\n *\n * The `SafeInt` type represents a safe integer. Division (`div`) uses floor\n * division.\n */\nexport const SafeInt = {\n  /**\n   * Type guard that checks if a value is a safe integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));\n   *\n   * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));\n   *\n   * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a safe integer, `false` otherwise\n   * @see {@link isSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `SafeInt` (the lower saturation target\n   * of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `SafeInt` (the upper saturation target\n   * of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a safe integer.\n   *\n   * The result is non-negative and keeps the `SafeInt` brand.\n   *\n   * @example\n   *\n   * ```ts\n   * const negative = asSafeInt(-900);\n   *\n   * const absolute = SafeInt.abs(negative);\n   *\n   * assert.isTrue(absolute === 900);\n   *\n   * assert.isTrue(SafeInt.is(absolute));\n   * ```\n   *\n   * @param a - The safe integer value\n   * @returns The absolute value as a non-negative `SafeInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = SafeInt.min(asSafeInt(25), asSafeInt(-14), asSafeInt(99));\n   *\n   * assert.isTrue(smallest === -14);\n   * ```\n   *\n   * @param values - The safe integers to compare (at least one required)\n   * @returns The smallest value as a `SafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = SafeInt.max(asSafeInt(25), asSafeInt(-14), asSafeInt(99));\n   *\n   * assert.isTrue(largest === 99);\n   * ```\n   *\n   * @param values - The safe integers to compare (at least one required)\n   * @returns The largest value as a `SafeInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `SafeInt`, rounding to the nearest\n   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asSafeInt`, this is total: out-of-range inputs are clamped to the\n   * nearest representable `SafeInt` instead of throwing.\n   *\n   * @example\n   *\n   * ```ts\n   * const aboveRange = SafeInt.fromNumber(1e20);\n   *\n   * const withinRange = SafeInt.fromNumber(123);\n   *\n   * const belowRange = SafeInt.fromNumber(-1e20);\n   *\n   * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);\n   *\n   * assert.isTrue(withinRange === 123);\n   *\n   * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);\n   * ```\n   *\n   * @param value - The value to convert\n   * @returns The value as a `SafeInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `SafeInt` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asSafeInt(-10);\n   *\n   * const max = asSafeInt(10);\n   *\n   * const randomValue = SafeInt.random(min, max);\n   *\n   * assert.isTrue(SafeInt.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= -10 && randomValue <= 10);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `SafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `SafeInt` (floored to\n   * an integer).\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asSafeInt(3);\n   *\n   * const exponent = asSafeInt(5);\n   *\n   * const power = SafeInt.pow(base, exponent);\n   *\n   * assert.isTrue(power === 243);\n   *\n   * assert.isTrue(SafeInt.is(power));\n   * ```\n   *\n   * @param a - The base safe integer\n   * @param b - The exponent safe integer\n   * @returns `a ** b` as a `SafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two safe integers, returning `a + b` as a `SafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = SafeInt.add(asSafeInt(9), asSafeInt(4));\n   *\n   * assert.isTrue(sum === 13);\n   *\n   * assert.isTrue(SafeInt.is(sum));\n   * ```\n   *\n   * @param a - The first safe integer\n   * @param b - The second safe integer\n   * @returns The sum of `a` and `b` as a `SafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two safe integers, returning `a - b` as a `SafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = SafeInt.sub(asSafeInt(9), asSafeInt(14));\n   *\n   * assert.isTrue(difference === -5);\n   *\n   * assert.isTrue(SafeInt.is(difference));\n   * ```\n   *\n   * @param a - The first safe integer\n   * @param b - The second safe integer\n   * @returns The difference of `a` and `b` as a `SafeInt`\n   */\n  sub,\n\n  /**\n   * Multiplies two safe integers, returning `a * b` as a `SafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = SafeInt.mul(asSafeInt(-8), asSafeInt(7));\n   *\n   * assert.isTrue(product === -56);\n   *\n   * assert.isTrue(SafeInt.is(product));\n   * ```\n   *\n   * @param a - The first safe integer\n   * @param b - The second safe integer\n   * @returns The product of `a` and `b` as a `SafeInt`\n   */\n  mul,\n\n  /**\n   * Divides two safe integers using floor division (`⌊a / b⌋`): the result is\n   * `a / b` rounded toward negative infinity, as a `SafeInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = SafeInt.div(asSafeInt(-17), asSafeInt(5));\n   *\n   * assert.isTrue(quotient === -4);\n   *\n   * assert.isTrue(SafeInt.is(quotient));\n   * ```\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `SafeInt`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof SafeInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof SafeInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,gBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;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;AAAA,EAEtB,WAAW,MAAA,CAAO,gBAAA;AAAA;AAAA,EAElB,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAoBH,MAAM,SAAA,GAAY;AAsBlB,MAAM,SAAA,GAAY;AAQlB,MAAM,OAAA,GAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBrB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4BL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBA;AACF;;;;"}

package/dist/number/branded-types/safe-uint.d.mts

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

package/dist/number/branded-types/safe-uint.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-uint.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/safe-uint.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,IAAI,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAItE,MAAM,MAAM,QAAQ,GAAG,oBAAoB,CAAC;AAgC5C;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,0CAAK,CAAC;AAE7B;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;MAAW,CAAC;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"safe-uint.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/safe-uint.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,IAAI,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAItE,MAAM,MAAM,QAAQ,GAAG,oBAAoB,CAAC;AAgC5C;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,0CAAK,CAAC;AAE7B;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;MAAW,CAAC;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;OASG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;CAEK,CAAC"}