ts-data-forge 11.0.1 → 12.0.0

package/dist/number/branded-types/non-zero-uint16.d.mts

@@ -55,11 +55,13 @@ export declare const NonZeroUint16: {
      */
     readonly is: (a: number) => a is import("ts-type-forge").PositiveUint16;
     /**
-     * The smallest value representable as `NonZeroUint16`.
+     * The smallest value representable as `NonZeroUint16` (the lower saturation
+     * target of `fromNumber`).
      */
     readonly MIN_VALUE: 1;
     /**
-     * The largest value representable as `NonZeroUint16`.
+     * The largest value representable as `NonZeroUint16` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
@@ -77,13 +79,17 @@ export declare const NonZeroUint16: {
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>[]) => import("ts-type-forge").PositiveUint16;
     /**
-     * Clamps a `number` into the `NonZeroUint16` range, rounding to the nearest
-     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+     * Converts an arbitrary `number` into a `NonZeroUint16`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
      *
-     * @param value - The value to clamp
-     * @returns The clamped value as a `NonZeroUint16`
+     * Unlike `asNonZeroUint16`, this is total: out-of-range inputs are clamped to
+     * the nearest representable `NonZeroUint16` instead of throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `NonZeroUint16`
      */
-    readonly clamp: (x: number) => import("ts-type-forge").PositiveUint16;
+    readonly fromNumber: (x: number) => import("ts-type-forge").PositiveUint16;
     /**
      * Generates a random `NonZeroUint16` within the given range.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-uint16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA8BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,4DAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}
+{"version":3,"file":"non-zero-uint16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA8BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,4DAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}

package/dist/number/branded-types/non-zero-uint16.mjs

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

package/dist/number/branded-types/non-zero-uint16.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"non-zero-uint16.mjs","sources":["../../../src/number/branded-types/non-zero-uint16.mts"],"sourcesContent":["import { type NonZeroUint16 as TtfImported_NonZeroUint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroUint16 = TtfImported_NonZeroUint16;\n\ntype ElementType = NonZeroUint16;\n\nconst typeNameInMessage = 'a non-zero integer in [1, 2^16)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\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 non-zero integer in [1, 2^16).\n *\n * Returns `true` for a non-zero 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 non-zero integer in [1, 2^16), `false` otherwise\n */\nexport const isNonZeroUint16 = is;\n\n/**\n * Casts a `number` to the `NonZeroUint16` branded type.\n *\n * Validates that the value is a non-zero integer in [1, 2^16) and returns it\n * with the `NonZeroUint16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroUint16`\n * @throws {TypeError} If the value is not a non-zero integer in [1, 2^16)\n */\nexport const asNonZeroUint16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroUint16` branded\n * type.\n *\n * The `NonZeroUint16` type represents a non-zero integer in [1, 2^16). Division\n * (`div`) uses floor division.\n */\nexport const NonZeroUint16 = {\n  /**\n   * Type guard that checks if a value is a non-zero integer in [1, 2^16).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero integer in [1, 2^16), `false` otherwise\n   * @see {@link isNonZeroUint16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonZeroUint16`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonZeroUint16`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroUint16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The largest value as a `NonZeroUint16`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonZeroUint16` 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 `NonZeroUint16`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NonZeroUint16` 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 `NonZeroUint16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint16`\n   * (floored to an integer).\n   *\n   * @param a - The base non-zero integer\n   * @param b - The exponent non-zero integer\n   * @returns `a ** b` as a `NonZeroUint16`\n   */\n  pow,\n\n  /**\n   * Adds two non-zero integers, returning `a + b` as a `NonZeroUint16`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The sum of `a` and `b` as a `NonZeroUint16`\n   */\n  add,\n\n  /**\n   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint16`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The product of `a` and `b` as a `NonZeroUint16`\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroUint16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroUint16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\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,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,eAAA,GAAkB;AAYxB,MAAM,eAAA,GAAkB;AASxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,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;AACF;;;;"}
+{"version":3,"file":"non-zero-uint16.mjs","sources":["../../../src/number/branded-types/non-zero-uint16.mts"],"sourcesContent":["import { type NonZeroUint16 as TtfImported_NonZeroUint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroUint16 = TtfImported_NonZeroUint16;\n\ntype ElementType = NonZeroUint16;\n\nconst typeNameInMessage = 'a non-zero integer in [1, 2^16)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\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 non-zero integer in [1, 2^16).\n *\n * Returns `true` for a non-zero 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 non-zero integer in [1, 2^16), `false` otherwise\n */\nexport const isNonZeroUint16 = is;\n\n/**\n * Casts a `number` to the `NonZeroUint16` branded type.\n *\n * Validates that the value is a non-zero integer in [1, 2^16) and returns it\n * with the `NonZeroUint16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroUint16`\n * @throws {TypeError} If the value is not a non-zero integer in [1, 2^16)\n */\nexport const asNonZeroUint16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroUint16` branded\n * type.\n *\n * The `NonZeroUint16` type represents a non-zero integer in [1, 2^16). Division\n * (`div`) uses floor division.\n */\nexport const NonZeroUint16 = {\n  /**\n   * Type guard that checks if a value is a non-zero integer in [1, 2^16).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero integer in [1, 2^16), `false` otherwise\n   * @see {@link isNonZeroUint16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonZeroUint16` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonZeroUint16` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroUint16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The largest value as a `NonZeroUint16`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonZeroUint16`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNonZeroUint16`, this is total: out-of-range inputs are clamped to\n   * the nearest representable `NonZeroUint16` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonZeroUint16`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NonZeroUint16` 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 `NonZeroUint16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint16`\n   * (floored to an integer).\n   *\n   * @param a - The base non-zero integer\n   * @param b - The exponent non-zero integer\n   * @returns `a ** b` as a `NonZeroUint16`\n   */\n  pow,\n\n  /**\n   * Adds two non-zero integers, returning `a + b` as a `NonZeroUint16`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The sum of `a` and `b` as a `NonZeroUint16`\n   */\n  add,\n\n  /**\n   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint16`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The product of `a` and `b` as a `NonZeroUint16`\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroUint16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroUint16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\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,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,eAAA,GAAkB;AAYxB,MAAM,eAAA,GAAkB;AASxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,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;AACF;;;;"}

package/dist/number/branded-types/non-zero-uint32.d.mts

@@ -53,11 +53,13 @@ export declare const NonZeroUint32: {
      */
     readonly is: (a: number) => a is import("ts-type-forge").PositiveUint32;
     /**
-     * The smallest value representable as `NonZeroUint32`.
+     * The smallest value representable as `NonZeroUint32` (the lower saturation
+     * target of `fromNumber`).
      */
     readonly MIN_VALUE: 1;
     /**
-     * The largest value representable as `NonZeroUint32`.
+     * The largest value representable as `NonZeroUint32` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
@@ -75,13 +77,17 @@ export declare const NonZeroUint32: {
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>[]) => import("ts-type-forge").PositiveUint32;
     /**
-     * Clamps a `number` into the `NonZeroUint32` range, rounding to the nearest
-     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+     * Converts an arbitrary `number` into a `NonZeroUint32`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
      *
-     * @param value - The value to clamp
-     * @returns The clamped value as a `NonZeroUint32`
+     * Unlike `asNonZeroUint32`, this is total: out-of-range inputs are clamped to
+     * the nearest representable `NonZeroUint32` instead of throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `NonZeroUint32`
      */
-    readonly clamp: (x: number) => import("ts-type-forge").PositiveUint32;
+    readonly fromNumber: (x: number) => import("ts-type-forge").PositiveUint32;
     /**
      * Generates a random `NonZeroUint32` within the given range.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA8BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,4DAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}
+{"version":3,"file":"non-zero-uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA8BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,4DAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}

package/dist/number/branded-types/non-zero-uint32.mjs

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

package/dist/number/branded-types/non-zero-uint32.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"non-zero-uint32.mjs","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"sourcesContent":["import { type NonZeroUint32 as TtfImported_NonZeroUint32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroUint32 = TtfImported_NonZeroUint32;\n\ntype ElementType = NonZeroUint32;\n\nconst typeNameInMessage = 'a non-zero integer in [1, 2^32)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\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 non-zero integer in [1, 2^32).\n *\n * Returns `true` for a non-zero 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 non-zero integer in [1, 2^32), `false` otherwise\n */\nexport const isNonZeroUint32 = is;\n\n/**\n * Casts a `number` to the `NonZeroUint32` branded type.\n *\n * Validates that the value is a non-zero integer in [1, 2^32) and returns it\n * with the `NonZeroUint32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroUint32`\n * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32)\n */\nexport const asNonZeroUint32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroUint32` branded\n * type.\n *\n * The `NonZeroUint32` type represents a non-zero integer in [1, 2^32). Division\n * (`div`) uses floor division.\n */\nexport const NonZeroUint32 = {\n  /**\n   * Type guard that checks if a value is a non-zero integer in [1, 2^32).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise\n   * @see {@link isNonZeroUint32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonZeroUint32`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonZeroUint32`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroUint32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The largest value as a `NonZeroUint32`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonZeroUint32` 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 `NonZeroUint32`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NonZeroUint32` 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 `NonZeroUint32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint32`\n   * (floored to an integer).\n   *\n   * @param a - The base non-zero integer\n   * @param b - The exponent non-zero integer\n   * @returns `a ** b` as a `NonZeroUint32`\n   */\n  pow,\n\n  /**\n   * Adds two non-zero integers, returning `a + b` as a `NonZeroUint32`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The sum of `a` and `b` as a `NonZeroUint32`\n   */\n  add,\n\n  /**\n   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint32`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The product of `a` and `b` as a `NonZeroUint32`\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroUint32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroUint32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\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,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,eAAA,GAAkB;AAYxB,MAAM,eAAA,GAAkB;AASxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,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;AACF;;;;"}
+{"version":3,"file":"non-zero-uint32.mjs","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"sourcesContent":["import { type NonZeroUint32 as TtfImported_NonZeroUint32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroUint32 = TtfImported_NonZeroUint32;\n\ntype ElementType = NonZeroUint32;\n\nconst typeNameInMessage = 'a non-zero integer in [1, 2^32)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\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 non-zero integer in [1, 2^32).\n *\n * Returns `true` for a non-zero 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 non-zero integer in [1, 2^32), `false` otherwise\n */\nexport const isNonZeroUint32 = is;\n\n/**\n * Casts a `number` to the `NonZeroUint32` branded type.\n *\n * Validates that the value is a non-zero integer in [1, 2^32) and returns it\n * with the `NonZeroUint32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroUint32`\n * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32)\n */\nexport const asNonZeroUint32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroUint32` branded\n * type.\n *\n * The `NonZeroUint32` type represents a non-zero integer in [1, 2^32). Division\n * (`div`) uses floor division.\n */\nexport const NonZeroUint32 = {\n  /**\n   * Type guard that checks if a value is a non-zero integer in [1, 2^32).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise\n   * @see {@link isNonZeroUint32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonZeroUint32` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonZeroUint32` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroUint32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The largest value as a `NonZeroUint32`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonZeroUint32`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNonZeroUint32`, this is total: out-of-range inputs are clamped to\n   * the nearest representable `NonZeroUint32` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonZeroUint32`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NonZeroUint32` 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 `NonZeroUint32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint32`\n   * (floored to an integer).\n   *\n   * @param a - The base non-zero integer\n   * @param b - The exponent non-zero integer\n   * @returns `a ** b` as a `NonZeroUint32`\n   */\n  pow,\n\n  /**\n   * Adds two non-zero integers, returning `a + b` as a `NonZeroUint32`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The sum of `a` and `b` as a `NonZeroUint32`\n   */\n  add,\n\n  /**\n   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint32`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The product of `a` and `b` as a `NonZeroUint32`\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroUint32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroUint32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\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,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,eAAA,GAAkB;AAYxB,MAAM,eAAA,GAAkB;AASxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,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;AACF;;;;"}

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

@@ -51,7 +51,10 @@ export declare const PositiveFiniteNumber: {
      */
     readonly is: (a: number) => a is TtfImported_PositiveFiniteNumber;
     /**
-     * The smallest value representable as `PositiveFiniteNumber`.
+     * The smallest value representable as `PositiveFiniteNumber` (the lower
+     * saturation target of `fromNumber`). The domain is open at `0` (excluded),
+     * so this is `Number.MIN_VALUE` — the smallest positive double — rather than
+     * `0`.
      */
     readonly MIN_VALUE: number;
     /**
@@ -69,13 +72,17 @@ export declare const PositiveFiniteNumber: {
      */
     readonly max: (...values: readonly TtfImported_PositiveFiniteNumber[]) => TtfImported_PositiveFiniteNumber;
     /**
-     * Clamps a `number` into the `PositiveFiniteNumber` range `[MIN_VALUE,
-     * MAX_VALUE]`.
+     * Converts an arbitrary `number` into a `PositiveFiniteNumber`, saturating it
+     * into the range `[MIN_VALUE, MAX_VALUE]`.
      *
-     * @param value - The value to clamp
-     * @returns The clamped value as a `PositiveFiniteNumber`
+     * Unlike `asPositiveFiniteNumber`, this is total: out-of-range inputs are
+     * clamped to the nearest representable `PositiveFiniteNumber` instead of
+     * throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `PositiveFiniteNumber`
      */
-    readonly clamp: (x: number) => TtfImported_PositiveFiniteNumber;
+    readonly fromNumber: (x: number) => TtfImported_PositiveFiniteNumber;
     /**
      * Returns the greatest integer less than or equal to a positive finite
      * number.

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

@@ -1 +1 @@
-{"version":3,"file":"positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oBAAoB,IAAI,gCAAgC,EAE9D,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AAEpE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAqExC;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,sDAAK,CAAC;AAEzC;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;wBApHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAoHC;;;;;;OAMG;uBAjHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAmH3D;;;;;;OAMG;wBApHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAoHC;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oBAAoB,IAAI,gCAAgC,EAE9D,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AAEpE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAqExC;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,sDAAK,CAAC;AAEzC;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;OAMG;wBA3HA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA2HC;;;;;;OAMG;uBAxHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IA0H3D;;;;;;OAMG;wBA3HA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA2HC;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;CAEK,CAAC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"positive-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":["import {\n  type PositiveInt,\n  type PositiveFiniteNumber as TtfImported_PositiveFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;\n\ntype ElementType = PositiveFiniteNumber;\n\nconst typeNameInMessage = 'a positive 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  number,\n  number\n>({\n  MIN_VALUE: Number.MIN_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\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.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.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\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  PositiveInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Uint\n>('=');\n\n/**\n * Type guard that checks if a value is a 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 positive finite number, `false` otherwise\n */\nexport const isPositiveFiniteNumber = is;\n\n/**\n * Casts a `number` to the `PositiveFiniteNumber` branded type.\n *\n * Validates that the value is a positive finite number and returns it with the\n * `PositiveFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveFiniteNumber`\n * @throws {TypeError} If the value is not a positive finite number\n */\nexport const asPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveFiniteNumber`\n * branded type.\n *\n * The `PositiveFiniteNumber` type represents a positive finite number.\n */\nexport const PositiveFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a positive finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive finite number, `false` otherwise\n   * @see {@link isPositiveFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveFiniteNumber`.\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The smallest value as a `PositiveFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The largest value as a `PositiveFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `PositiveFiniteNumber` range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `PositiveFiniteNumber`\n   */\n  clamp,\n\n  /**\n   * Returns the greatest integer less than or equal to a positive finite\n   * number.\n   *\n   * @param a - The 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 positive finite\n   * number.\n   *\n   * @param a - The positive finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a positive finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The positive finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `PositiveFiniteNumber` 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 `PositiveFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The base positive finite number\n   * @param b - The exponent positive finite number\n   * @returns `a ** b` as a `PositiveFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two positive finite numbers, returning `a + b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two positive finite numbers, returning `a - b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive finite numbers, returning `a * b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The product of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two positive finite numbers, returning `a / b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `PositiveFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'positive'>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,0BAAA;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,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;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,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAyBK,MAAM,sBAAA,GAAyB;AAY/B,MAAM,sBAAA,GAAyB;AAQ/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,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":"positive-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":["import {\n  type PositiveInt,\n  type PositiveFiniteNumber as TtfImported_PositiveFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;\n\ntype ElementType = PositiveFiniteNumber;\n\nconst typeNameInMessage = 'a positive 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  number,\n  number\n>({\n  MIN_VALUE: Number.MIN_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\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.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.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\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  PositiveInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Uint\n>('=');\n\n/**\n * Type guard that checks if a value is a 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 positive finite number, `false` otherwise\n */\nexport const isPositiveFiniteNumber = is;\n\n/**\n * Casts a `number` to the `PositiveFiniteNumber` branded type.\n *\n * Validates that the value is a positive finite number and returns it with the\n * `PositiveFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveFiniteNumber`\n * @throws {TypeError} If the value is not a positive finite number\n */\nexport const asPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveFiniteNumber`\n * branded type.\n *\n * The `PositiveFiniteNumber` type represents a positive finite number.\n */\nexport const PositiveFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a positive finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive finite number, `false` otherwise\n   * @see {@link isPositiveFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveFiniteNumber` (the lower\n   * saturation target of `fromNumber`). The domain is open at `0` (excluded),\n   * so this is `Number.MIN_VALUE` — the smallest positive double — rather than\n   * `0`.\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The smallest value as a `PositiveFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The largest value as a `PositiveFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `PositiveFiniteNumber`, saturating it\n   * into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asPositiveFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `PositiveFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `PositiveFiniteNumber`\n   */\n  fromNumber,\n\n  /**\n   * Returns the greatest integer less than or equal to a positive finite\n   * number.\n   *\n   * @param a - The 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 positive finite\n   * number.\n   *\n   * @param a - The positive finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a positive finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The positive finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `PositiveFiniteNumber` 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 `PositiveFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The base positive finite number\n   * @param b - The exponent positive finite number\n   * @returns `a ** b` as a `PositiveFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two positive finite numbers, returning `a + b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two positive finite numbers, returning `a - b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive finite numbers, returning `a * b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The product of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two positive finite numbers, returning `a / b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `PositiveFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'positive'>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,0BAAA;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,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;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,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAyBK,MAAM,sBAAA,GAAyB;AAY/B,MAAM,sBAAA,GAAyB;AAQ/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,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/positive-int.d.mts

@@ -84,7 +84,8 @@ export declare const PositiveInt: {
      */
     readonly is: (a: number) => a is TtfImported_PositiveInt;
     /**
-     * The smallest value representable as `PositiveInt`.
+     * The smallest value representable as `PositiveInt` (the lower saturation
+     * target of `fromNumber`).
      */
     readonly MIN_VALUE: 1;
     /**
@@ -126,25 +127,29 @@ export declare const PositiveInt: {
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>[]) => TtfImported_PositiveInt;
     /**
-     * Clamps a `number` into the `PositiveInt` range, rounding to the nearest
-     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+     * Converts an arbitrary `number` into a `PositiveInt`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asPositiveInt`, this is total: out-of-range inputs are clamped to
+     * the nearest representable `PositiveInt` instead of throwing.
      *
      * @example
      *
      * ```ts
-     * const belowRange = PositiveInt.clamp(0);
+     * const belowRange = PositiveInt.fromNumber(0);
      *
-     * const withinRange = PositiveInt.clamp(10);
+     * const withinRange = PositiveInt.fromNumber(10);
      *
      * assert.isTrue(belowRange === 1);
      *
      * assert.isTrue(withinRange === 10);
      * ```
      *
-     * @param value - The value to clamp
-     * @returns The clamped value as a `PositiveInt`
+     * @param value - The value to convert
+     * @returns The value as a `PositiveInt`
      */
-    readonly clamp: (x: number) => TtfImported_PositiveInt;
+    readonly fromNumber: (x: number) => TtfImported_PositiveInt;
     /**
      * Generates a random `PositiveInt` within the given range.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"positive-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,IAAI,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAI5E,MAAM,MAAM,WAAW,GAAG,uBAAuB,CAAC;AA8BlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,aAAa,6CAAK,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;MAAW,CAAC;AAEtC;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;IACtB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;OAEG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,IAAI,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAI5E,MAAM,MAAM,WAAW,GAAG,uBAAuB,CAAC;AA8BlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,aAAa,6CAAK,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;MAAW,CAAC;AAEtC;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;IACtB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;OAGG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;;;;;;;;;;;;;;CAEK,CAAC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"positive-int.mjs","sources":["../../../src/number/branded-types/positive-int.mts"],"sourcesContent":["import { type PositiveInt as TtfImported_PositiveInt } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveInt = TtfImported_PositiveInt;\n\ntype ElementType = PositiveInt;\n\nconst typeNameInMessage = 'a positive integer';\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.operatorsForInteger<\n  ElementType,\n  1,\n  number\n>({\n  integerOrSafeInteger: 'Integer',\n  MIN_VALUE: 1,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive integer.\n *\n * Returns `true` for a positive integer — a value with no fractional component,\n * including values outside the safe integer range (unlike `SafeInt`).\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isPositiveInt(5));\n *\n * assert.isFalse(isPositiveInt(0));\n *\n * assert.isTrue(PositiveInt.is(10));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive integer, `false` otherwise\n */\nexport const isPositiveInt = is;\n\n/**\n * Casts a `number` to the `PositiveInt` branded type.\n *\n * Validates that the value is a positive integer and returns it with the\n * `PositiveInt` brand. Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asPositiveInt(7);\n *\n * assert.isTrue(branded === 7);\n *\n * assert.isTrue(PositiveInt.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveInt`\n * @throws {TypeError} If the value is not a positive integer\n */\nexport const asPositiveInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveInt` branded type.\n *\n * The `PositiveInt` type represents a positive integer. Division (`div`) uses\n * floor division.\n *\n * Unlike `SafeInt`, `PositiveInt` allows values outside the safe integer range\n * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's\n * `number` type.\n */\nexport const PositiveInt = {\n  /**\n   * Type guard that checks if a value is a positive integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isPositiveInt(5));\n   *\n   * assert.isFalse(isPositiveInt(0));\n   *\n   * assert.isTrue(PositiveInt.is(10));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive integer, `false` otherwise\n   * @see {@link isPositiveInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveInt`.\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given positive integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = PositiveInt.min(\n   *   asPositiveInt(9),\n   *   asPositiveInt(3),\n   *   asPositiveInt(12),\n   * );\n   *\n   * assert.isTrue(smallest === 3);\n   * ```\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = PositiveInt.max(\n   *   asPositiveInt(9),\n   *   asPositiveInt(3),\n   *   asPositiveInt(12),\n   * );\n   *\n   * assert.isTrue(largest === 12);\n   * ```\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The largest value as a `PositiveInt`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `PositiveInt` 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 = PositiveInt.clamp(0);\n   *\n   * const withinRange = PositiveInt.clamp(10);\n   *\n   * assert.isTrue(belowRange === 1);\n   *\n   * assert.isTrue(withinRange === 10);\n   * ```\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `PositiveInt`\n   */\n  clamp,\n\n  /**\n   * Generates a random `PositiveInt` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asPositiveInt(3);\n   *\n   * const max = asPositiveInt(6);\n   *\n   * const randomValue = PositiveInt.random(min, max);\n   *\n   * assert.isTrue(PositiveInt.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= 3 && randomValue <= 6);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `PositiveInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt` (floored\n   * to an integer).\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asPositiveInt(2);\n   *\n   * const exponent = asPositiveInt(4);\n   *\n   * const power = PositiveInt.pow(base, exponent);\n   *\n   * assert.isTrue(power === 16);\n   * ```\n   *\n   * @param a - The base positive integer\n   * @param b - The exponent positive integer\n   * @returns `a ** b` as a `PositiveInt`\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, returning `a + b` as a `PositiveInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = PositiveInt.add(asPositiveInt(4), asPositiveInt(5));\n   *\n   * assert.isTrue(sum === 9);\n   * ```\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 `PositiveInt`\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, returning `a - b` as a `PositiveInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = PositiveInt.sub(asPositiveInt(5), asPositiveInt(7));\n   *\n   * assert.isTrue(difference === 1);\n   * ```\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 `PositiveInt`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, returning `a * b` as a `PositiveInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = PositiveInt.mul(asPositiveInt(3), asPositiveInt(7));\n   *\n   * assert.isTrue(product === 21);\n   * ```\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 `PositiveInt`\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 `PositiveInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = PositiveInt.div(asPositiveInt(9), asPositiveInt(2));\n   *\n   * const clamped = PositiveInt.div(asPositiveInt(3), asPositiveInt(10));\n   *\n   * assert.isTrue(quotient === 4);\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 `PositiveInt`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,oBAAA;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,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,SAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAqBH,MAAM,aAAA,GAAgB;AAsBtB,MAAM,aAAA,GAAgB;AAYtB,MAAM,WAAA,GAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBzB,EAAA;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,EAoBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBL,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,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA;AACF;;;;"}
+{"version":3,"file":"positive-int.mjs","sources":["../../../src/number/branded-types/positive-int.mts"],"sourcesContent":["import { type PositiveInt as TtfImported_PositiveInt } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveInt = TtfImported_PositiveInt;\n\ntype ElementType = PositiveInt;\n\nconst typeNameInMessage = 'a positive integer';\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.operatorsForInteger<\n  ElementType,\n  1,\n  number\n>({\n  integerOrSafeInteger: 'Integer',\n  MIN_VALUE: 1,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive integer.\n *\n * Returns `true` for a positive integer — a value with no fractional component,\n * including values outside the safe integer range (unlike `SafeInt`).\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isPositiveInt(5));\n *\n * assert.isFalse(isPositiveInt(0));\n *\n * assert.isTrue(PositiveInt.is(10));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive integer, `false` otherwise\n */\nexport const isPositiveInt = is;\n\n/**\n * Casts a `number` to the `PositiveInt` branded type.\n *\n * Validates that the value is a positive integer and returns it with the\n * `PositiveInt` brand. Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asPositiveInt(7);\n *\n * assert.isTrue(branded === 7);\n *\n * assert.isTrue(PositiveInt.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveInt`\n * @throws {TypeError} If the value is not a positive integer\n */\nexport const asPositiveInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveInt` branded type.\n *\n * The `PositiveInt` type represents a positive integer. Division (`div`) uses\n * floor division.\n *\n * Unlike `SafeInt`, `PositiveInt` allows values outside the safe integer range\n * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's\n * `number` type.\n */\nexport const PositiveInt = {\n  /**\n   * Type guard that checks if a value is a positive integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isPositiveInt(5));\n   *\n   * assert.isFalse(isPositiveInt(0));\n   *\n   * assert.isTrue(PositiveInt.is(10));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive integer, `false` otherwise\n   * @see {@link isPositiveInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveInt` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given positive integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = PositiveInt.min(\n   *   asPositiveInt(9),\n   *   asPositiveInt(3),\n   *   asPositiveInt(12),\n   * );\n   *\n   * assert.isTrue(smallest === 3);\n   * ```\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = PositiveInt.max(\n   *   asPositiveInt(9),\n   *   asPositiveInt(3),\n   *   asPositiveInt(12),\n   * );\n   *\n   * assert.isTrue(largest === 12);\n   * ```\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The largest value as a `PositiveInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `PositiveInt`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asPositiveInt`, this is total: out-of-range inputs are clamped to\n   * the nearest representable `PositiveInt` instead of throwing.\n   *\n   * @example\n   *\n   * ```ts\n   * const belowRange = PositiveInt.fromNumber(0);\n   *\n   * const withinRange = PositiveInt.fromNumber(10);\n   *\n   * assert.isTrue(belowRange === 1);\n   *\n   * assert.isTrue(withinRange === 10);\n   * ```\n   *\n   * @param value - The value to convert\n   * @returns The value as a `PositiveInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `PositiveInt` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asPositiveInt(3);\n   *\n   * const max = asPositiveInt(6);\n   *\n   * const randomValue = PositiveInt.random(min, max);\n   *\n   * assert.isTrue(PositiveInt.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= 3 && randomValue <= 6);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `PositiveInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt` (floored\n   * to an integer).\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asPositiveInt(2);\n   *\n   * const exponent = asPositiveInt(4);\n   *\n   * const power = PositiveInt.pow(base, exponent);\n   *\n   * assert.isTrue(power === 16);\n   * ```\n   *\n   * @param a - The base positive integer\n   * @param b - The exponent positive integer\n   * @returns `a ** b` as a `PositiveInt`\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, returning `a + b` as a `PositiveInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = PositiveInt.add(asPositiveInt(4), asPositiveInt(5));\n   *\n   * assert.isTrue(sum === 9);\n   * ```\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 `PositiveInt`\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, returning `a - b` as a `PositiveInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = PositiveInt.sub(asPositiveInt(5), asPositiveInt(7));\n   *\n   * assert.isTrue(difference === 1);\n   * ```\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 `PositiveInt`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, returning `a * b` as a `PositiveInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = PositiveInt.mul(asPositiveInt(3), asPositiveInt(7));\n   *\n   * assert.isTrue(product === 21);\n   * ```\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 `PositiveInt`\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 `PositiveInt`.\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = PositiveInt.div(asPositiveInt(9), asPositiveInt(2));\n   *\n   * const clamped = PositiveInt.div(asPositiveInt(3), asPositiveInt(10));\n   *\n   * assert.isTrue(quotient === 4);\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 `PositiveInt`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,oBAAA;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,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,SAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA,EACX,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAqBH,MAAM,aAAA,GAAgB;AAsBtB,MAAM,aAAA,GAAgB;AAYtB,MAAM,WAAA,GAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBzB,EAAA;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,EAoBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBL,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,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,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA;AACF;;;;"}

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

@@ -56,11 +56,13 @@ export declare const PositiveInt16: {
      */
     readonly is: (a: number) => a is TtfImported_PositiveInt16;
     /**
-     * The smallest value representable as `PositiveInt16`.
+     * The smallest value representable as `PositiveInt16` (the lower saturation
+     * target of `fromNumber`).
      */
     readonly MIN_VALUE: 1;
     /**
-     * The largest value representable as `PositiveInt16`.
+     * The largest value representable as `PositiveInt16` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
@@ -78,13 +80,17 @@ export declare const PositiveInt16: {
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt16>[]) => TtfImported_PositiveInt16;
     /**
-     * Clamps a `number` into the `PositiveInt16` range, rounding to the nearest
-     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
+     * Converts an arbitrary `number` into a `PositiveInt16`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
      *
-     * @param value - The value to clamp
-     * @returns The clamped value as a `PositiveInt16`
+     * Unlike `asPositiveInt16`, this is total: out-of-range inputs are clamped to
+     * the nearest representable `PositiveInt16` instead of throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `PositiveInt16`
      */
-    readonly clamp: (x: number) => TtfImported_PositiveInt16;
+    readonly fromNumber: (x: number) => TtfImported_PositiveInt16;
     /**
      * Generates a random `PositiveInt16` within the given range.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"positive-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA+BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,+CAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;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-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA+BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,+CAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;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"}