ts-data-forge 11.0.0 → 12.0.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_,
@@ -26,7 +26,7 @@ const isPositiveSafeInt = is;
 const asPositiveSafeInt = castType;
 const PositiveSafeInt = {
   /**
-   * Type guard to check if a value is a PositiveSafeInt.
+   * Type guard that checks if a value is a positive safe integer.
    *
    * @example
    *
@@ -40,25 +40,23 @@ const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(42));
    * ```
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a positive safe integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a positive safe integer, `false` otherwise
    * @see {@link isPositiveSafeInt} for usage examples
    */
   is,
   /**
-   * The minimum value for a positive safe integer.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveSafeInt` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum safe integer value (2^53 - 1).
-   *
-   * @readonly
+   * The largest value representable as `PositiveSafeInt` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two PositiveSafeInt values.
+   * Returns the smallest of the given positive safe integers.
    *
    * @example
    *
@@ -71,13 +69,12 @@ const PositiveSafeInt = {
    * assert.isTrue(smallest === 5);
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns The minimum value as a PositiveSafeInt.
+   * @param values - The positive safe integers to compare (at least one required)
+   * @returns The smallest value as a `PositiveSafeInt`
    */
   min: min_,
   /**
-   * Returns the larger of two PositiveSafeInt values.
+   * Returns the largest of the given positive safe integers.
    *
    * @example
    *
@@ -90,22 +87,26 @@ const PositiveSafeInt = {
    * assert.isTrue(largest === 10);
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns The maximum value as a PositiveSafeInt.
+   * @param values - The positive safe integers to compare (at least one required)
+   * @returns The largest value as a `PositiveSafeInt`
    */
   max: max_,
   /**
-   * Clamps a number to the positive safe integer range.
+   * 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);
    *
@@ -114,12 +115,14 @@ const PositiveSafeInt = {
    * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
    * ```
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param value - The value to convert
+   * @returns The value as a `PositiveSafeInt`
    */
-  clamp,
+  fromNumber,
   /**
-   * Generates a random PositiveSafeInt value within the valid range.
+   * Generates a random `PositiveSafeInt` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -135,11 +138,14 @@ const PositiveSafeInt = {
    * assert.isTrue(randomValue >= 1 && randomValue <= 6);
    * ```
    *
-   * @returns A random PositiveSafeInt between 1 and MAX_SAFE_INTEGER.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveSafeInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a PositiveSafeInt to the power of another PositiveSafeInt.
+   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveSafeInt`
+   * (floored to an integer).
    *
    * @example
    *
@@ -153,13 +159,13 @@ const PositiveSafeInt = {
    * assert.isTrue(power === 27);
    * ```
    *
-   * @param a The base PositiveSafeInt.
-   * @param b The exponent PositiveSafeInt.
-   * @returns `a ** b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The base positive safe integer
+   * @param b - The exponent positive safe integer
+   * @returns `a ** b` as a `PositiveSafeInt`
    */
   pow,
   /**
-   * Adds two PositiveSafeInt values.
+   * Adds two positive safe integers, returning `a + b` as a `PositiveSafeInt`.
    *
    * @example
    *
@@ -174,13 +180,14 @@ const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(sum));
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns `a + b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The sum of `a` and `b` as a `PositiveSafeInt`
    */
   add,
   /**
-   * Subtracts one PositiveSafeInt from another.
+   * Subtracts two positive safe integers, returning `a - b` as a
+   * `PositiveSafeInt`.
    *
    * @example
    *
@@ -195,14 +202,14 @@ const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(difference));
    * ```
    *
-   * @param a The minuend PositiveSafeInt.
-   * @param b The subtrahend PositiveSafeInt.
-   * @returns `a - b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt
-   *   (minimum 1).
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The difference of `a` and `b` as a `PositiveSafeInt`
    */
   sub,
   /**
-   * Multiplies two PositiveSafeInt values.
+   * Multiplies two positive safe integers, returning `a * b` as a
+   * `PositiveSafeInt`.
    *
    * @example
    *
@@ -217,13 +224,14 @@ const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(product));
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns `a * b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The product of `a` and `b` as a `PositiveSafeInt`
    */
   mul,
   /**
-   * Divides one PositiveSafeInt by another using floor division.
+   * Divides two positive safe integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as a `PositiveSafeInt`.
    *
    * @example
    *
@@ -243,9 +251,9 @@ const PositiveSafeInt = {
    * assert.isTrue(clamped === 1);
    * ```
    *
-   * @param a The dividend PositiveSafeInt.
-   * @param b The divisor PositiveSafeInt.
-   * @returns `⌊a / b⌋` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `PositiveSafeInt`
    */
   div
 };

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 * Checks if a number is a PositiveSafeInt (a positive safe integer in the range\n * [1, MAX_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 PositiveSafeInt, `false` otherwise.\n */\nexport const isPositiveSafeInt = is;\n\n/**\n * Casts a number to a PositiveSafeInt type.\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 type.\n * @throws {TypeError} If the value is not a positive safe integer.\n */\nexport const asPositiveSafeInt = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for positive safe\n * integers.\n *\n * All operations automatically clamp results to the positive safe integer range\n * [1, MAX_SAFE_INTEGER]. This ensures that all arithmetic maintains both the\n * positive constraint and IEEE 754 precision guarantees, preventing precision\n * loss and ensuring results are always positive.\n */\nexport const PositiveSafeInt = {\n  /**\n   * Type guard to check if a value is a PositiveSafeInt.\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 minimum value for a positive safe integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum safe integer value (2^53 - 1).\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two PositiveSafeInt values.\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 a The first PositiveSafeInt.\n   * @param b The second PositiveSafeInt.\n   * @returns The minimum value as a PositiveSafeInt.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two PositiveSafeInt values.\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 a The first PositiveSafeInt.\n   * @param b The second PositiveSafeInt.\n   * @returns The maximum value as a PositiveSafeInt.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the positive safe integer range.\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 number to clamp.\n   * @returns The value clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.\n   */\n  clamp,\n\n  /**\n   * Generates a random PositiveSafeInt value within the valid range.\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   * @returns A random PositiveSafeInt between 1 and MAX_SAFE_INTEGER.\n   */\n  random,\n\n  /**\n   * Raises a PositiveSafeInt to the power of another PositiveSafeInt.\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 PositiveSafeInt.\n   * @param b The exponent PositiveSafeInt.\n   * @returns `a ** b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.\n   */\n  pow,\n\n  /**\n   * Adds two PositiveSafeInt values.\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 PositiveSafeInt.\n   * @param b The second PositiveSafeInt.\n   * @returns `a + b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.\n   */\n  add,\n\n  /**\n   * Subtracts one PositiveSafeInt from another.\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 minuend PositiveSafeInt.\n   * @param b The subtrahend PositiveSafeInt.\n   * @returns `a - b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt\n   *   (minimum 1).\n   */\n  sub,\n\n  /**\n   * Multiplies two PositiveSafeInt values.\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 PositiveSafeInt.\n   * @param b The second PositiveSafeInt.\n   * @returns `a * b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.\n   */\n  mul,\n\n  /**\n   * Divides one PositiveSafeInt by another using floor division.\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 PositiveSafeInt.\n   * @param b The divisor PositiveSafeInt.\n   * @returns `⌊a / b⌋` clamped to [1, MAX_SAFE_INTEGER] 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;AAqBH,MAAM,iBAAA,GAAoB;AAmB1B,MAAM,iBAAA,GAAoB;AAW1B,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;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,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,EAwBL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,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,EAsBA,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,EA2BA;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

@@ -1,19 +1,24 @@
 import { type PositiveUint16 as TtfImported_PositiveUint16 } from 'ts-type-forge';
 export type PositiveUint16 = TtfImported_PositiveUint16;
 /**
- * Checks if a number is a PositiveUint16 (16-bit positive unsigned integer in
- * the range [1, 2^16)).
+ * Type guard that checks if a value is a positive integer in [1, 2^16).
  *
- * @param value The value to check.
- * @returns `true` if the value is a PositiveUint16, `false` otherwise.
+ * Returns `true` for a positive integer in [1, 2^16) — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a positive integer in [1, 2^16), `false` otherwise
  */
 export declare const isPositiveUint16: (a: number) => a is TtfImported_PositiveUint16;
 /**
- * Casts a number to a PositiveUint16 type.
+ * Casts a `number` to the `PositiveUint16` branded type.
+ *
+ * Validates that the value is a positive integer in [1, 2^16) and returns it
+ * with the `PositiveUint16` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a PositiveUint16 type.
- * @throws {TypeError} If the value is not a positive integer in [1, 2^16).
+ * @param value - The value to cast
+ * @returns The value as a `PositiveUint16`
+ * @throws {TypeError} If the value is not a positive integer in [1, 2^16)
  */
 export declare const asPositiveUint16: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -34,102 +39,107 @@ export declare const asPositiveUint16: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 16-bit positive
- * unsigned integers.
+ * Namespace providing type-safe operations for the `PositiveUint16` branded
+ * type.
  *
- * All operations automatically clamp results to the valid PositiveUint16 range
- * [1, 65535]. This ensures that all arithmetic maintains the 16-bit positive
- * unsigned integer constraint, with results below 1 clamped to MIN_VALUE and
- * overflow results clamped to MAX_VALUE.
+ * The `PositiveUint16` type represents a positive integer in [1, 2^16).
+ * Division (`div`) uses floor division.
  */
 export declare const PositiveUint16: {
     /**
-     * Type guard to check if a value is a PositiveUint16.
+     * Type guard that checks if a value is a positive integer in [1, 2^16).
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a 16-bit positive unsigned integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a positive integer in [1, 2^16), `false` otherwise
+     * @see {@link isPositiveUint16} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_PositiveUint16;
     /**
-     * The minimum value for a 16-bit positive unsigned integer.
-     *
-     * @readonly
+     * The smallest value representable as `PositiveUint16` (the lower saturation
+     * target of `fromNumber`).
      */
     readonly MIN_VALUE: 1;
     /**
-     * The maximum value for a 16-bit positive unsigned integer.
-     *
-     * @readonly
+     * The largest value representable as `PositiveUint16` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the smaller of two PositiveUint16 values.
+     * Returns the smallest of the given positive integers.
      *
-     * @param a The first PositiveUint16.
-     * @param b The second PositiveUint16.
-     * @returns The minimum value as a PositiveUint16.
+     * @param values - The positive integers to compare (at least one required)
+     * @returns The smallest value as a `PositiveUint16`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>[]) => TtfImported_PositiveUint16;
     /**
-     * Returns the larger of two PositiveUint16 values.
+     * Returns the largest of the given positive integers.
      *
-     * @param a The first PositiveUint16.
-     * @param b The second PositiveUint16.
-     * @returns The maximum value as a PositiveUint16.
+     * @param values - The positive integers to compare (at least one required)
+     * @returns The largest value as a `PositiveUint16`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>[]) => TtfImported_PositiveUint16;
     /**
-     * Clamps a number to the PositiveUint16 range.
+     * Converts an arbitrary `number` into a `PositiveUint16`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asPositiveUint16`, this is total: out-of-range inputs are clamped
+     * to the nearest representable `PositiveUint16` instead of throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [1, 65535] as a PositiveUint16.
+     * @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 value within the valid range.
+     * Generates a random `PositiveUint16` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random PositiveUint16 between 1 and 65535.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `PositiveUint16` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16> | undefined) => TtfImported_PositiveUint16;
     /**
-     * Raises a PositiveUint16 to the power of another PositiveUint16.
+     * Raises `a` to the power `b`, returning `a ** b` as a `PositiveUint16`
+     * (floored to an integer).
      *
-     * @param a The base PositiveUint16.
-     * @param b The exponent PositiveUint16.
-     * @returns `a ** b` clamped to [1, 65535] as a PositiveUint16.
+     * @param a - The base positive integer
+     * @param b - The exponent positive integer
+     * @returns `a ** b` as a `PositiveUint16`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>) => TtfImported_PositiveUint16;
     /**
-     * Adds two PositiveUint16 values.
+     * Adds two positive integers, returning `a + b` as a `PositiveUint16`.
      *
-     * @param a The first PositiveUint16.
-     * @param b The second PositiveUint16.
-     * @returns `a + b` clamped to [1, 65535] as a PositiveUint16.
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The sum of `a` and `b` as a `PositiveUint16`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>) => TtfImported_PositiveUint16;
     /**
-     * Subtracts one PositiveUint16 from another.
+     * Subtracts two positive integers, returning `a - b` as a `PositiveUint16`.
      *
-     * @param a The minuend PositiveUint16.
-     * @param b The subtrahend PositiveUint16.
-     * @returns `a - b` clamped to [1, 65535] as a PositiveUint16 (minimum 1).
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The difference of `a` and `b` as a `PositiveUint16`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>) => TtfImported_PositiveUint16;
     /**
-     * Multiplies two PositiveUint16 values.
+     * Multiplies two positive integers, returning `a * b` as a `PositiveUint16`.
      *
-     * @param a The first PositiveUint16.
-     * @param b The second PositiveUint16.
-     * @returns `a * b` clamped to [1, 65535] as a PositiveUint16.
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The product of `a` and `b` as a `PositiveUint16`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>) => TtfImported_PositiveUint16;
     /**
-     * Divides one PositiveUint16 by another using floor division.
+     * Divides two positive integers using floor division (`⌊a / b⌋`): the result
+     * is `a / b` rounded toward negative infinity, as a `PositiveUint16`.
      *
-     * @param a The dividend PositiveUint16.
-     * @param b The divisor PositiveUint16.
-     * @returns `⌊a / b⌋` clamped to [1, 65535] as a PositiveUint16.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as a `PositiveUint16`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>, y: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
         readonly "!=0": true;

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;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;MAAW,CAAC;AAEzC;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;;;;;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_,
@@ -25,92 +25,99 @@ const isPositiveUint16 = is;
 const asPositiveUint16 = castType;
 const PositiveUint16 = {
   /**
-   * Type guard to check if a value is a PositiveUint16.
+   * Type guard that checks if a value is a positive integer in [1, 2^16).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 16-bit positive unsigned integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a positive integer in [1, 2^16), `false` otherwise
+   * @see {@link isPositiveUint16} for usage examples
    */
   is,
   /**
-   * The minimum value for a 16-bit positive unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveUint16` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 16-bit positive unsigned integer.
-   *
-   * @readonly
+   * The largest value representable as `PositiveUint16` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two PositiveUint16 values.
+   * Returns the smallest of the given positive integers.
    *
-   * @param a The first PositiveUint16.
-   * @param b The second PositiveUint16.
-   * @returns The minimum value as a PositiveUint16.
+   * @param values - The positive integers to compare (at least one required)
+   * @returns The smallest value as a `PositiveUint16`
    */
   min: min_,
   /**
-   * Returns the larger of two PositiveUint16 values.
+   * Returns the largest of the given positive integers.
    *
-   * @param a The first PositiveUint16.
-   * @param b The second PositiveUint16.
-   * @returns The maximum value as a PositiveUint16.
+   * @param values - The positive integers to compare (at least one required)
+   * @returns The largest value as a `PositiveUint16`
    */
   max: max_,
   /**
-   * Clamps a number to the PositiveUint16 range.
+   * 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 number to clamp.
-   * @returns The value clamped to [1, 65535] 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 value within the valid range.
+   * Generates a random `PositiveUint16` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random PositiveUint16 between 1 and 65535.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveUint16` in `[min, max]`
    */
   random,
   /**
-   * Raises a PositiveUint16 to the power of another PositiveUint16.
+   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveUint16`
+   * (floored to an integer).
    *
-   * @param a The base PositiveUint16.
-   * @param b The exponent PositiveUint16.
-   * @returns `a ** b` clamped to [1, 65535] as a PositiveUint16.
+   * @param a - The base positive integer
+   * @param b - The exponent positive integer
+   * @returns `a ** b` as a `PositiveUint16`
    */
   pow,
   /**
-   * Adds two PositiveUint16 values.
+   * Adds two positive integers, returning `a + b` as a `PositiveUint16`.
    *
-   * @param a The first PositiveUint16.
-   * @param b The second PositiveUint16.
-   * @returns `a + b` clamped to [1, 65535] as a PositiveUint16.
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The sum of `a` and `b` as a `PositiveUint16`
    */
   add,
   /**
-   * Subtracts one PositiveUint16 from another.
+   * Subtracts two positive integers, returning `a - b` as a `PositiveUint16`.
    *
-   * @param a The minuend PositiveUint16.
-   * @param b The subtrahend PositiveUint16.
-   * @returns `a - b` clamped to [1, 65535] as a PositiveUint16 (minimum 1).
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The difference of `a` and `b` as a `PositiveUint16`
    */
   sub,
   /**
-   * Multiplies two PositiveUint16 values.
+   * Multiplies two positive integers, returning `a * b` as a `PositiveUint16`.
    *
-   * @param a The first PositiveUint16.
-   * @param b The second PositiveUint16.
-   * @returns `a * b` clamped to [1, 65535] as a PositiveUint16.
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The product of `a` and `b` as a `PositiveUint16`
    */
   mul,
   /**
-   * Divides one PositiveUint16 by another using floor division.
+   * Divides two positive integers using floor division (`⌊a / b⌋`): the result
+   * is `a / b` rounded toward negative infinity, as a `PositiveUint16`.
    *
-   * @param a The dividend PositiveUint16.
-   * @param b The divisor PositiveUint16.
-   * @returns `⌊a / b⌋` clamped to [1, 65535] as a PositiveUint16.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `PositiveUint16`
    */
   div
 };