ts-data-forge 10.0.0 → 11.0.1

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

@@ -3,8 +3,8 @@ export type PositiveInt = TtfImported_PositiveInt;
 /**
  * Type guard that checks if a value is a positive integer.
  *
- * A positive integer is any integer greater than zero (>= 1). This excludes
- * zero, negative numbers, and non-integers.
+ * Returns `true` for a positive integer — a value with no fractional component,
+ * including values outside the safe integer range (unlike `SafeInt`).
  *
  * @example
  *
@@ -21,11 +21,10 @@ export type PositiveInt = TtfImported_PositiveInt;
  */
 export declare const isPositiveInt: (a: number) => a is TtfImported_PositiveInt;
 /**
- * Casts a number to a PositiveInt branded type.
+ * Casts a `number` to the `PositiveInt` branded type.
  *
- * This function validates that the input is a positive integer (>= 1) and
- * returns it with the PositiveInt brand. This ensures type safety for
- * operations that require strictly positive integer values.
+ * Validates that the value is a positive integer and returns it with the
+ * `PositiveInt` brand. Throws a `TypeError` otherwise.
  *
  * @example
  *
@@ -38,7 +37,7 @@ export declare const isPositiveInt: (a: number) => a is TtfImported_PositiveInt;
  * ```
  *
  * @param value - The value to cast
- * @returns The value as a PositiveInt branded type
+ * @returns The value as a `PositiveInt`
  * @throws {TypeError} If the value is not a positive integer
  */
 export declare const asPositiveInt: <N extends number>(x: N) => number & {
@@ -56,20 +55,14 @@ export declare const asPositiveInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe operations for PositiveInt branded types.
+ * Namespace providing type-safe operations for the `PositiveInt` branded type.
  *
- * PositiveInt represents integers that are strictly greater than zero (>= 1).
- * All operations automatically clamp results to maintain the positive
- * constraint, ensuring that arithmetic operations never produce zero or
- * negative values.
+ * The `PositiveInt` type represents a positive integer. Division (`div`) uses
+ * floor division.
  *
- * This type is essential for:
- *
- * - Array lengths and sizes (length >= 1)
- * - Counts and quantities that must be positive
- * - Denominators in division operations
- * - Loop counters and iteration counts
- * - Database primary keys and IDs
+ * Unlike `SafeInt`, `PositiveInt` allows values outside the safe integer range
+ * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's
+ * `number` type.
  */
 export declare const PositiveInt: {
     /**
@@ -91,16 +84,11 @@ export declare const PositiveInt: {
      */
     readonly is: (a: number) => a is TtfImported_PositiveInt;
     /**
-     * The minimum value for a PositiveInt.
-     *
-     * @readonly
+     * The smallest value representable as `PositiveInt`.
      */
     readonly MIN_VALUE: 1;
     /**
-     * Returns the minimum value from a list of positive integers.
-     *
-     * Since all inputs are guaranteed to be >= 1, the result is also guaranteed
-     * to be a positive integer.
+     * Returns the smallest of the given positive integers.
      *
      * @example
      *
@@ -115,11 +103,11 @@ export declare const PositiveInt: {
      * ```
      *
      * @param values - The positive integers to compare (at least one required)
-     * @returns The smallest value as a PositiveInt
+     * @returns The smallest value as a `PositiveInt`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>[]) => TtfImported_PositiveInt;
     /**
-     * Returns the maximum value from a list of positive integers.
+     * Returns the largest of the given positive integers.
      *
      * @example
      *
@@ -134,14 +122,12 @@ export declare const PositiveInt: {
      * ```
      *
      * @param values - The positive integers to compare (at least one required)
-     * @returns The largest value as a PositiveInt
+     * @returns The largest value as a `PositiveInt`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>[]) => TtfImported_PositiveInt;
     /**
-     * Clamps a number to the positive integer range.
-     *
-     * Since PositiveInt has a minimum value of 1, this function ensures that any
-     * input less than 1 is clamped to 1.
+     * Clamps a `number` into the `PositiveInt` range, rounding to the nearest
+     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
      * @example
      *
@@ -155,15 +141,14 @@ export declare const PositiveInt: {
      * assert.isTrue(withinRange === 10);
      * ```
      *
-     * @param value - The number to clamp
-     * @returns The value clamped to >= 1 as a PositiveInt
+     * @param value - The value to clamp
+     * @returns The clamped value as a `PositiveInt`
      */
     readonly clamp: (x: number) => TtfImported_PositiveInt;
     /**
-     * Generates a random positive integer within the specified range (inclusive).
+     * Generates a random `PositiveInt` within the given range.
      *
-     * Both bounds are inclusive, and both min and max must be positive integers.
-     * If min > max, they are automatically swapped.
+     * The range is inclusive on both ends.
      *
      * @example
      *
@@ -179,14 +164,14 @@ export declare const PositiveInt: {
      * assert.isTrue(randomValue >= 3 && randomValue <= 6);
      * ```
      *
-     * @param min - The minimum value (inclusive, must be >= 1)
-     * @param max - The maximum value (inclusive, must be >= min)
-     * @returns A random PositiveInt in the range [min, max]
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `PositiveInt` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt> | undefined) => TtfImported_PositiveInt;
     /**
-     * Raises a positive integer to a power, ensuring the result is never less
-     * than 1.
+     * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt` (floored
+     * to an integer).
      *
      * @example
      *
@@ -202,11 +187,11 @@ export declare const PositiveInt: {
      *
      * @param a - The base positive integer
      * @param b - The exponent positive integer
-     * @returns `a ** b` as a PositiveInt, but never less than 1
+     * @returns `a ** b` as a `PositiveInt`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>) => TtfImported_PositiveInt;
     /**
-     * Adds two positive integers, ensuring the result is never less than 1.
+     * Adds two positive integers, returning `a + b` as a `PositiveInt`.
      *
      * @example
      *
@@ -216,16 +201,13 @@ export declare const PositiveInt: {
      * assert.isTrue(sum === 9);
      * ```
      *
-     * @param a - First positive integer
-     * @param b - Second positive integer
-     * @returns `a + b` as a PositiveInt, but never less than 1
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The sum of `a` and `b` as a `PositiveInt`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>) => TtfImported_PositiveInt;
     /**
-     * Subtracts two positive integers, clamping the result to remain positive.
-     *
-     * If the mathematical result would be <= 0, it is clamped to 1 to maintain
-     * the positive integer constraint.
+     * Subtracts two positive integers, returning `a - b` as a `PositiveInt`.
      *
      * @example
      *
@@ -235,13 +217,13 @@ export declare const PositiveInt: {
      * assert.isTrue(difference === 1);
      * ```
      *
-     * @param a - The minuend (positive integer)
-     * @param b - The subtrahend (positive integer)
-     * @returns `max(1, a - b)` as a PositiveInt
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The difference of `a` and `b` as a `PositiveInt`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>) => TtfImported_PositiveInt;
     /**
-     * Multiplies two positive integers, ensuring the result is never less than 1.
+     * Multiplies two positive integers, returning `a * b` as a `PositiveInt`.
      *
      * @example
      *
@@ -251,18 +233,14 @@ export declare const PositiveInt: {
      * assert.isTrue(product === 21);
      * ```
      *
-     * @param a - First positive integer
-     * @param b - Second positive integer
-     * @returns `a * b` as a PositiveInt, but never less than 1
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The product of `a` and `b` as a `PositiveInt`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>) => TtfImported_PositiveInt;
     /**
-     * Divides two positive integers using floor division, clamping to remain
-     * positive.
-     *
-     * Performs mathematical floor division: `⌊a / b⌋`. If the result would be 0
-     * (when a < b), it is clamped to 1 to maintain the positive integer
-     * constraint.
+     * Divides two positive integers using floor division (`⌊a / b⌋`): the result
+     * is `a / b` rounded toward negative infinity, as a `PositiveInt`.
      *
      * @example
      *
@@ -276,9 +254,9 @@ export declare const PositiveInt: {
      * assert.isTrue(clamped === 1);
      * ```
      *
-     * @param a - The dividend (positive integer)
-     * @param b - The divisor (positive integer, guaranteed non-zero)
-     * @returns `max(1, ⌊a / b⌋)` as a PositiveInt
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as a `PositiveInt`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, 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-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;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;MAAW,CAAC;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW;IACtB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;OAIG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;OAuBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;OAuBG;;;;;;;;;;;;;;;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;;OAEG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;;;;;;;;;;;;;;CAEK,CAAC"}

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

@@ -42,16 +42,11 @@ const PositiveInt = {
    */
   is,
   /**
-   * The minimum value for a PositiveInt.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveInt`.
    */
   MIN_VALUE,
   /**
-   * Returns the minimum value from a list of positive integers.
-   *
-   * Since all inputs are guaranteed to be >= 1, the result is also guaranteed
-   * to be a positive integer.
+   * Returns the smallest of the given positive integers.
    *
    * @example
    *
@@ -66,11 +61,11 @@ const PositiveInt = {
    * ```
    *
    * @param values - The positive integers to compare (at least one required)
-   * @returns The smallest value as a PositiveInt
+   * @returns The smallest value as a `PositiveInt`
    */
   min: min_,
   /**
-   * Returns the maximum value from a list of positive integers.
+   * Returns the largest of the given positive integers.
    *
    * @example
    *
@@ -85,14 +80,12 @@ const PositiveInt = {
    * ```
    *
    * @param values - The positive integers to compare (at least one required)
-   * @returns The largest value as a PositiveInt
+   * @returns The largest value as a `PositiveInt`
    */
   max: max_,
   /**
-   * Clamps a number to the positive integer range.
-   *
-   * Since PositiveInt has a minimum value of 1, this function ensures that any
-   * input less than 1 is clamped to 1.
+   * Clamps a `number` into the `PositiveInt` range, rounding to the nearest
+   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
    * @example
    *
@@ -106,15 +99,14 @@ const PositiveInt = {
    * assert.isTrue(withinRange === 10);
    * ```
    *
-   * @param value - The number to clamp
-   * @returns The value clamped to >= 1 as a PositiveInt
+   * @param value - The value to clamp
+   * @returns The clamped value as a `PositiveInt`
    */
   clamp,
   /**
-   * Generates a random positive integer within the specified range (inclusive).
+   * Generates a random `PositiveInt` within the given range.
    *
-   * Both bounds are inclusive, and both min and max must be positive integers.
-   * If min > max, they are automatically swapped.
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -130,14 +122,14 @@ const PositiveInt = {
    * assert.isTrue(randomValue >= 3 && randomValue <= 6);
    * ```
    *
-   * @param min - The minimum value (inclusive, must be >= 1)
-   * @param max - The maximum value (inclusive, must be >= min)
-   * @returns A random PositiveInt in the range [min, max]
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a positive integer to a power, ensuring the result is never less
-   * than 1.
+   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt` (floored
+   * to an integer).
    *
    * @example
    *
@@ -153,11 +145,11 @@ const PositiveInt = {
    *
    * @param a - The base positive integer
    * @param b - The exponent positive integer
-   * @returns `a ** b` as a PositiveInt, but never less than 1
+   * @returns `a ** b` as a `PositiveInt`
    */
   pow,
   /**
-   * Adds two positive integers, ensuring the result is never less than 1.
+   * Adds two positive integers, returning `a + b` as a `PositiveInt`.
    *
    * @example
    *
@@ -167,16 +159,13 @@ const PositiveInt = {
    * assert.isTrue(sum === 9);
    * ```
    *
-   * @param a - First positive integer
-   * @param b - Second positive integer
-   * @returns `a + b` as a PositiveInt, but never less than 1
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The sum of `a` and `b` as a `PositiveInt`
    */
   add,
   /**
-   * Subtracts two positive integers, clamping the result to remain positive.
-   *
-   * If the mathematical result would be <= 0, it is clamped to 1 to maintain
-   * the positive integer constraint.
+   * Subtracts two positive integers, returning `a - b` as a `PositiveInt`.
    *
    * @example
    *
@@ -186,13 +175,13 @@ const PositiveInt = {
    * assert.isTrue(difference === 1);
    * ```
    *
-   * @param a - The minuend (positive integer)
-   * @param b - The subtrahend (positive integer)
-   * @returns `max(1, a - b)` as a PositiveInt
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The difference of `a` and `b` as a `PositiveInt`
    */
   sub,
   /**
-   * Multiplies two positive integers, ensuring the result is never less than 1.
+   * Multiplies two positive integers, returning `a * b` as a `PositiveInt`.
    *
    * @example
    *
@@ -202,18 +191,14 @@ const PositiveInt = {
    * assert.isTrue(product === 21);
    * ```
    *
-   * @param a - First positive integer
-   * @param b - Second positive integer
-   * @returns `a * b` as a PositiveInt, but never less than 1
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The product of `a` and `b` as a `PositiveInt`
    */
   mul,
   /**
-   * Divides two positive integers using floor division, clamping to remain
-   * positive.
-   *
-   * Performs mathematical floor division: `⌊a / b⌋`. If the result would be 0
-   * (when a < b), it is clamped to 1 to maintain the positive integer
-   * constraint.
+   * Divides two positive integers using floor division (`⌊a / b⌋`): the result
+   * is `a / b` rounded toward negative infinity, as a `PositiveInt`.
    *
    * @example
    *
@@ -227,9 +212,9 @@ const PositiveInt = {
    * assert.isTrue(clamped === 1);
    * ```
    *
-   * @param a - The dividend (positive integer)
-   * @param b - The divisor (positive integer, guaranteed non-zero)
-   * @returns `max(1, ⌊a / b⌋)` as a PositiveInt
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `PositiveInt`
    */
   div
 };

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 * A positive integer is any integer greater than zero (>= 1). This excludes\n * zero, negative numbers, and non-integers.\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 a PositiveInt branded type.\n *\n * This function validates that the input is a positive integer (>= 1) and\n * returns it with the PositiveInt brand. This ensures type safety for\n * operations that require strictly positive integer values.\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 branded type\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 PositiveInt branded types.\n *\n * PositiveInt represents integers that are strictly greater than zero (>= 1).\n * All operations automatically clamp results to maintain the positive\n * constraint, ensuring that arithmetic operations never produce zero or\n * negative values.\n *\n * This type is essential for:\n *\n * - Array lengths and sizes (length >= 1)\n * - Counts and quantities that must be positive\n * - Denominators in division operations\n * - Loop counters and iteration counts\n * - Database primary keys and IDs\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 minimum value for a PositiveInt.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the minimum value from a list of positive integers.\n   *\n   * Since all inputs are guaranteed to be >= 1, the result is also guaranteed\n   * to be a positive integer.\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 maximum value from a list of 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 to the positive integer range.\n   *\n   * Since PositiveInt has a minimum value of 1, this function ensures that any\n   * input less than 1 is clamped to 1.\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 number to clamp\n   * @returns The value clamped to >= 1 as a PositiveInt\n   */\n  clamp,\n\n  /**\n   * Generates a random positive integer within the specified range (inclusive).\n   *\n   * Both bounds are inclusive, and both min and max must be positive integers.\n   * If min > max, they are automatically swapped.\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, must be >= 1)\n   * @param max - The maximum value (inclusive, must be >= min)\n   * @returns A random PositiveInt in the range [min, max]\n   */\n  random,\n\n  /**\n   * Raises a positive integer to a power, ensuring the result is never less\n   * than 1.\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, but never less than 1\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, ensuring the result is never less than 1.\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 - First positive integer\n   * @param b - Second positive integer\n   * @returns `a + b` as a PositiveInt, but never less than 1\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, clamping the result to remain positive.\n   *\n   * If the mathematical result would be <= 0, it is clamped to 1 to maintain\n   * the positive integer constraint.\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 minuend (positive integer)\n   * @param b - The subtrahend (positive integer)\n   * @returns `max(1, a - b)` as a PositiveInt\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, ensuring the result is never less than 1.\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 - First positive integer\n   * @param b - Second positive integer\n   * @returns `a * b` as a PositiveInt, but never less than 1\n   */\n  mul,\n\n  /**\n   * Divides two positive integers using floor division, clamping to remain\n   * positive.\n   *\n   * Performs mathematical floor division: `⌊a / b⌋`. If the result would be 0\n   * (when a < b), it is clamped to 1 to maintain the positive integer\n   * constraint.\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 (positive integer)\n   * @param b - The divisor (positive integer, guaranteed non-zero)\n   * @returns `max(1, ⌊a / b⌋)` 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;AAuBtB,MAAM,aAAA,GAAgB;AAkBtB,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;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBA,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,EAuBL,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;AAAA,EA0BA,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;AAAA;AAAA;AAAA,EAoBA,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;AAAA;AAAA;AAAA;AAAA,EA0BA;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  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;;;;"}