ts-data-forge 8.0.0 → 9.0.1

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

@@ -1,284 +1,253 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a positive safe integer';
-const { MAX_VALUE, MIN_VALUE, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'SafeInteger',
-    MIN_VALUE: 1,
-    // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer
-    MAX_VALUE: Number.MAX_SAFE_INTEGER,
-    typeNameInMessage,
+const typeNameInMessage = "a positive safe integer";
+const {
+  MAX_VALUE,
+  MIN_VALUE,
+  add,
+  castType,
+  clamp,
+  div,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "SafeInteger",
+  MIN_VALUE: 1,
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer
+  MAX_VALUE: Number.MAX_SAFE_INTEGER,
+  typeNameInMessage
 });
-/**
- * Checks if a number is a PositiveSafeInt (a positive safe integer in the range
- * [1, MAX_SAFE_INTEGER]).
- *
- * @example
- *
- * ```ts
- * assert.isTrue(isPositiveSafeInt(1));
- *
- * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));
- *
- * assert.isFalse(isPositiveSafeInt(0));
- *
- * assert.isTrue(PositiveSafeInt.is(42));
- * ```
- *
- * @param value The value to check.
- * @returns `true` if the value is a PositiveSafeInt, `false` otherwise.
- */
 const isPositiveSafeInt = is;
-/**
- * Casts a number to a PositiveSafeInt type.
- *
- * @example
- *
- * ```ts
- * const branded = asPositiveSafeInt(128);
- *
- * assert.isTrue(branded === 128);
- *
- * assert.isTrue(PositiveSafeInt.is(branded));
- * ```
- *
- * @param value The value to cast.
- * @returns The value as a PositiveSafeInt type.
- * @throws {TypeError} If the value is not a positive safe integer.
- */
 const asPositiveSafeInt = castType;
-/**
- * Namespace providing type-safe arithmetic operations for positive safe
- * integers.
- *
- * All operations automatically clamp results to the positive safe integer range
- * [1, MAX_SAFE_INTEGER]. This ensures that all arithmetic maintains both the
- * positive constraint and IEEE 754 precision guarantees, preventing precision
- * loss and ensuring results are always positive.
- */
 const PositiveSafeInt = {
-    /**
-     * Type guard to check if a value is a PositiveSafeInt.
-     *
-     * @example
-     *
-     * ```ts
-     * assert.isTrue(isPositiveSafeInt(1));
-     *
-     * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));
-     *
-     * assert.isFalse(isPositiveSafeInt(0));
-     *
-     * assert.isTrue(PositiveSafeInt.is(42));
-     * ```
-     *
-     * @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
-     */
-    MIN_VALUE,
-    /**
-     * The maximum safe integer value (2^53 - 1).
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the smaller of two PositiveSafeInt values.
-     *
-     * @example
-     *
-     * ```ts
-     * const smallest = PositiveSafeInt.min(
-     *   asPositiveSafeInt(10),
-     *   asPositiveSafeInt(5),
-     * );
-     *
-     * assert.isTrue(smallest === 5);
-     * ```
-     *
-     * @param a The first PositiveSafeInt.
-     * @param b The second PositiveSafeInt.
-     * @returns The minimum value as a PositiveSafeInt.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two PositiveSafeInt values.
-     *
-     * @example
-     *
-     * ```ts
-     * const largest = PositiveSafeInt.max(
-     *   asPositiveSafeInt(10),
-     *   asPositiveSafeInt(5),
-     * );
-     *
-     * assert.isTrue(largest === 10);
-     * ```
-     *
-     * @param a The first PositiveSafeInt.
-     * @param b The second PositiveSafeInt.
-     * @returns The maximum value as a PositiveSafeInt.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the positive safe integer range.
-     *
-     * @example
-     *
-     * ```ts
-     * const belowRange = PositiveSafeInt.clamp(0);
-     *
-     * const withinRange = PositiveSafeInt.clamp(123);
-     *
-     * const aboveRange = PositiveSafeInt.clamp(Number.MAX_SAFE_INTEGER + 10);
-     *
-     * assert.isTrue(belowRange === 1);
-     *
-     * assert.isTrue(withinRange === 123);
-     *
-     * 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.
-     */
-    clamp,
-    /**
-     * Generates a random PositiveSafeInt value within the valid range.
-     *
-     * @example
-     *
-     * ```ts
-     * const min = asPositiveSafeInt(1);
-     *
-     * const max = asPositiveSafeInt(6);
-     *
-     * const randomValue = PositiveSafeInt.random(min, max);
-     *
-     * assert.isTrue(PositiveSafeInt.is(randomValue));
-     *
-     * assert.isTrue(randomValue >= 1 && randomValue <= 6);
-     * ```
-     *
-     * @returns A random PositiveSafeInt between 1 and MAX_SAFE_INTEGER.
-     */
-    random,
-    /**
-     * Raises a PositiveSafeInt to the power of another PositiveSafeInt.
-     *
-     * @example
-     *
-     * ```ts
-     * const base = asPositiveSafeInt(3);
-     *
-     * const exponent = asPositiveSafeInt(3);
-     *
-     * const power = PositiveSafeInt.pow(base, exponent);
-     *
-     * 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.
-     */
-    pow,
-    /**
-     * Adds two PositiveSafeInt values.
-     *
-     * @example
-     *
-     * ```ts
-     * const sum = PositiveSafeInt.add(
-     *   asPositiveSafeInt(1000),
-     *   asPositiveSafeInt(2048),
-     * );
-     *
-     * assert.isTrue(sum === 3048);
-     *
-     * 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.
-     */
-    add,
-    /**
-     * Subtracts one PositiveSafeInt from another.
-     *
-     * @example
-     *
-     * ```ts
-     * const difference = PositiveSafeInt.sub(
-     *   asPositiveSafeInt(10),
-     *   asPositiveSafeInt(20),
-     * );
-     *
-     * assert.isTrue(difference === 1);
-     *
-     * 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).
-     */
-    sub,
-    /**
-     * Multiplies two PositiveSafeInt values.
-     *
-     * @example
-     *
-     * ```ts
-     * const product = PositiveSafeInt.mul(
-     *   asPositiveSafeInt(50),
-     *   asPositiveSafeInt(20),
-     * );
-     *
-     * assert.isTrue(product === 1000);
-     *
-     * 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.
-     */
-    mul,
-    /**
-     * Divides one PositiveSafeInt by another using floor division.
-     *
-     * @example
-     *
-     * ```ts
-     * const quotient = PositiveSafeInt.div(
-     *   asPositiveSafeInt(25),
-     *   asPositiveSafeInt(4),
-     * );
-     *
-     * const clamped = PositiveSafeInt.div(
-     *   asPositiveSafeInt(5),
-     *   asPositiveSafeInt(50),
-     * );
-     *
-     * assert.isTrue(quotient === 6);
-     *
-     * 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.
-     */
-    div,
+  /**
+   * Type guard to check if a value is a PositiveSafeInt.
+   *
+   * @example
+   *
+   * ```ts
+   * assert.isTrue(isPositiveSafeInt(1));
+   *
+   * assert.isTrue(isPositiveSafeInt(Number.MAX_SAFE_INTEGER));
+   *
+   * assert.isFalse(isPositiveSafeInt(0));
+   *
+   * assert.isTrue(PositiveSafeInt.is(42));
+   * ```
+   *
+   * @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
+   */
+  MIN_VALUE,
+  /**
+   * The maximum safe integer value (2^53 - 1).
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the smaller of two PositiveSafeInt values.
+   *
+   * @example
+   *
+   * ```ts
+   * const smallest = PositiveSafeInt.min(
+   *   asPositiveSafeInt(10),
+   *   asPositiveSafeInt(5),
+   * );
+   *
+   * assert.isTrue(smallest === 5);
+   * ```
+   *
+   * @param a The first PositiveSafeInt.
+   * @param b The second PositiveSafeInt.
+   * @returns The minimum value as a PositiveSafeInt.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two PositiveSafeInt values.
+   *
+   * @example
+   *
+   * ```ts
+   * const largest = PositiveSafeInt.max(
+   *   asPositiveSafeInt(10),
+   *   asPositiveSafeInt(5),
+   * );
+   *
+   * assert.isTrue(largest === 10);
+   * ```
+   *
+   * @param a The first PositiveSafeInt.
+   * @param b The second PositiveSafeInt.
+   * @returns The maximum value as a PositiveSafeInt.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the positive safe integer range.
+   *
+   * @example
+   *
+   * ```ts
+   * const belowRange = PositiveSafeInt.clamp(0);
+   *
+   * const withinRange = PositiveSafeInt.clamp(123);
+   *
+   * const aboveRange = PositiveSafeInt.clamp(Number.MAX_SAFE_INTEGER + 10);
+   *
+   * assert.isTrue(belowRange === 1);
+   *
+   * assert.isTrue(withinRange === 123);
+   *
+   * 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.
+   */
+  clamp,
+  /**
+   * Generates a random PositiveSafeInt value within the valid range.
+   *
+   * @example
+   *
+   * ```ts
+   * const min = asPositiveSafeInt(1);
+   *
+   * const max = asPositiveSafeInt(6);
+   *
+   * const randomValue = PositiveSafeInt.random(min, max);
+   *
+   * assert.isTrue(PositiveSafeInt.is(randomValue));
+   *
+   * assert.isTrue(randomValue >= 1 && randomValue <= 6);
+   * ```
+   *
+   * @returns A random PositiveSafeInt between 1 and MAX_SAFE_INTEGER.
+   */
+  random,
+  /**
+   * Raises a PositiveSafeInt to the power of another PositiveSafeInt.
+   *
+   * @example
+   *
+   * ```ts
+   * const base = asPositiveSafeInt(3);
+   *
+   * const exponent = asPositiveSafeInt(3);
+   *
+   * const power = PositiveSafeInt.pow(base, exponent);
+   *
+   * 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.
+   */
+  pow,
+  /**
+   * Adds two PositiveSafeInt values.
+   *
+   * @example
+   *
+   * ```ts
+   * const sum = PositiveSafeInt.add(
+   *   asPositiveSafeInt(1000),
+   *   asPositiveSafeInt(2048),
+   * );
+   *
+   * assert.isTrue(sum === 3048);
+   *
+   * 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.
+   */
+  add,
+  /**
+   * Subtracts one PositiveSafeInt from another.
+   *
+   * @example
+   *
+   * ```ts
+   * const difference = PositiveSafeInt.sub(
+   *   asPositiveSafeInt(10),
+   *   asPositiveSafeInt(20),
+   * );
+   *
+   * assert.isTrue(difference === 1);
+   *
+   * 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).
+   */
+  sub,
+  /**
+   * Multiplies two PositiveSafeInt values.
+   *
+   * @example
+   *
+   * ```ts
+   * const product = PositiveSafeInt.mul(
+   *   asPositiveSafeInt(50),
+   *   asPositiveSafeInt(20),
+   * );
+   *
+   * assert.isTrue(product === 1000);
+   *
+   * 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.
+   */
+  mul,
+  /**
+   * Divides one PositiveSafeInt by another using floor division.
+   *
+   * @example
+   *
+   * ```ts
+   * const quotient = PositiveSafeInt.div(
+   *   asPositiveSafeInt(25),
+   *   asPositiveSafeInt(4),
+   * );
+   *
+   * const clamped = PositiveSafeInt.div(
+   *   asPositiveSafeInt(5),
+   *   asPositiveSafeInt(50),
+   * );
+   *
+   * assert.isTrue(quotient === 6);
+   *
+   * 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.
+   */
+  div
 };
 
 export { PositiveSafeInt, asPositiveSafeInt, isPositiveSafeInt };

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":[null],"names":[],"mappings":";;AAWA,MAAM,iBAAiB,GAAG,yBAAyB;AAEnD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,GAAG,EACH,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,SAAS,EAAE,CAAC;;IAEZ,SAAS,EAAE,MAAM,CAAC,gBAA4B;IAC9C,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;;;;;;;;;;;;;AAkBG;AACI,MAAM,iBAAiB,GAAG;AAEjC;;;;;;;;;;;;;;;;AAgBG;AACI,MAAM,iBAAiB,GAAG;AAEjC;;;;;;;;AAQG;AACI,MAAM,eAAe,GAAG;AAC7B;;;;;;;;;;;;;;;;;;AAkBG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;;;;;;;;;;;;;AAiBG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;;;;;;;;;;;AAiBG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;;;;;;;;;;;;;;;AAqBG;IACH,KAAK;AAEL;;;;;;;;;;;;;;;;;;AAkBG;IACH,MAAM;AAEN;;;;;;;;;;;;;;;;;;AAkBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;;;;AAmBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;;;;;AAoBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;;;;AAmBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;IACH,GAAG;;;;;"}
+{"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;;;;"}

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

@@ -16,19 +16,19 @@ export declare const isPositiveUint16: (a: number) => a is TtfImported_PositiveU
  * @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 NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
+    readonly "!=0": true;
+    readonly "< 2^16": true;
+    readonly "< 2^31": true;
+    readonly "< 2^32": true;
+    readonly "<=0": false;
     readonly "> -2^16": true;
     readonly "> -2^32": true;
     readonly ">= -2^15": true;
     readonly ">= -2^31": true;
     readonly ">=0": true;
-    readonly "!=0": true;
-    readonly "<=0": false;
-    readonly "< 2^16": true;
-    readonly "< 2^31": true;
-    readonly "< 2^32": true;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
     readonly SafeInt: true;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
@@ -131,20 +131,20 @@ export declare const PositiveUint16: {
      * @param b The divisor PositiveUint16.
      * @returns `⌊a / b⌋` clamped to [1, 65535] as a PositiveUint16.
      */
-    readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveUint16>, y: 1 | 2 | 3 | 32 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 10 | 20 | 30 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 31 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
-        readonly NaNValue: false;
-        readonly Finite: true;
-        readonly Int: true;
+    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;
+        readonly "< 2^16": true;
+        readonly "< 2^31": true;
+        readonly "< 2^32": true;
+        readonly "<=0": false;
         readonly "> -2^16": true;
         readonly "> -2^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
-        readonly "!=0": true;
-        readonly "<=0": false;
-        readonly "< 2^16": true;
-        readonly "< 2^31": true;
-        readonly "< 2^32": true;
+        readonly Finite: true;
+        readonly Int: true;
+        readonly NaNValue: false;
         readonly SafeInt: true;
     } & Readonly<{
         'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;