ts-data-forge 8.0.0 → 9.0.1

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

@@ -1,301 +1,260 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a safe integer';
-const { MAX_VALUE, MIN_VALUE, abs, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'SafeInteger',
-    // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer
-    MIN_VALUE: Number.MIN_SAFE_INTEGER,
-    // 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 safe integer";
+const {
+  MAX_VALUE,
+  MIN_VALUE,
+  abs,
+  add,
+  castType,
+  clamp,
+  div,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "SafeInteger",
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer
+  MIN_VALUE: Number.MIN_SAFE_INTEGER,
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer
+  MAX_VALUE: Number.MAX_SAFE_INTEGER,
+  typeNameInMessage
 });
-/**
- * Type guard that checks if a value is a safe integer.
- *
- * A safe integer is an integer that can be exactly represented in JavaScript
- * without precision loss. The range is [±(2^53 - 1)].
- *
- * @example
- *
- * ```ts
- * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));
- *
- * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
- *
- * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));
- * ```
- *
- * @param value - The value to check
- * @returns `true` if the value is a safe integer, `false` otherwise
- */
 const isSafeInt = is;
-/**
- * Casts a number to a SafeInt branded type.
- *
- * This function validates that the input is a safe integer (within ±(2^53 - 1))
- * and returns it with the SafeInt brand. This ensures type safety for
- * operations that require precise integer arithmetic.
- *
- * @example
- *
- * ```ts
- * const branded = asSafeInt(123);
- *
- * assert.isTrue(branded === 123);
- *
- * assert.isTrue(SafeInt.is(branded));
- * ```
- *
- * @param value - The value to cast
- * @returns The value as a SafeInt branded type
- * @throws {TypeError} If the value is not a safe integer
- */
 const asSafeInt = castType;
-/**
- * Namespace providing type-safe operations for SafeInt branded types.
- *
- * SafeInt represents integers that can be exactly represented in JavaScript's
- * number type without precision loss. The range is [±(2^53 - 1)], which covers
- * approximately ±9 quadrillion.
- *
- * All operations automatically clamp results to stay within the safe range,
- * preventing precision loss that occurs with larger integers. This makes
- * SafeInt ideal for:
- *
- * - Financial calculations requiring exact cents
- * - Database IDs and counters
- * - Array indices and sizes
- * - Any integer arithmetic requiring precision guarantees
- */
 const SafeInt = {
-    /**
-     * Type guard that checks if a value is a safe integer.
-     *
-     * @example
-     *
-     * ```ts
-     * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));
-     *
-     * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
-     *
-     * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));
-     * ```
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is a safe integer, `false` otherwise
-     * @see {@link isSafeInt} for usage examples
-     */
-    is,
-    /**
-     * The minimum safe integer value (-(2^53 - 1)).
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * The maximum safe integer value (2^53 - 1).
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the absolute value of a safe integer.
-     *
-     * Note: `Math.abs(MIN_SAFE_INTEGER)` would exceed `MAX_SAFE_INTEGER`, so this
-     * function clamps the result to maintain the safe integer guarantee.
-     *
-     * @example
-     *
-     * ```ts
-     * const negative = asSafeInt(-900);
-     *
-     * const absolute = SafeInt.abs(negative);
-     *
-     * assert.isTrue(absolute === 900);
-     *
-     * assert.isTrue(SafeInt.is(absolute));
-     * ```
-     *
-     * @param a - The safe integer value
-     * @returns The absolute value as a SafeInt, clamped if necessary
-     */
-    abs,
-    /**
-     * Returns the minimum value from a list of safe integers.
-     *
-     * @example
-     *
-     * ```ts
-     * const smallest = SafeInt.min(asSafeInt(25), asSafeInt(-14), asSafeInt(99));
-     *
-     * assert.isTrue(smallest === -14);
-     * ```
-     *
-     * @param values - The safe integers to compare (at least one required)
-     * @returns The smallest value as a SafeInt
-     */
-    min: min_,
-    /**
-     * Returns the maximum value from a list of safe integers.
-     *
-     * @example
-     *
-     * ```ts
-     * const largest = SafeInt.max(asSafeInt(25), asSafeInt(-14), asSafeInt(99));
-     *
-     * assert.isTrue(largest === 99);
-     * ```
-     *
-     * @param values - The safe integers to compare (at least one required)
-     * @returns The largest value as a SafeInt
-     */
-    max: max_,
-    /**
-     * Clamps a number to the safe integer range.
-     *
-     * @example
-     *
-     * ```ts
-     * const aboveRange = SafeInt.clamp(1e20);
-     *
-     * const withinRange = SafeInt.clamp(123);
-     *
-     * const belowRange = SafeInt.clamp(-1e20);
-     *
-     * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
-     *
-     * assert.isTrue(withinRange === 123);
-     *
-     * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);
-     * ```
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] as a
-     *   SafeInt.
-     */
-    clamp,
-    /**
-     * Generates a random safe integer within the specified range (inclusive).
-     *
-     * The range is inclusive on both ends. If min > max, they are automatically
-     * swapped.
-     *
-     * @example
-     *
-     * ```ts
-     * const min = asSafeInt(-10);
-     *
-     * const max = asSafeInt(10);
-     *
-     * const randomValue = SafeInt.random(min, max);
-     *
-     * assert.isTrue(SafeInt.is(randomValue));
-     *
-     * assert.isTrue(randomValue >= -10 && randomValue <= 10);
-     * ```
-     *
-     * @param min - The minimum value (inclusive)
-     * @param max - The maximum value (inclusive)
-     * @returns A random SafeInt in the range [min, max]
-     */
-    random,
-    /**
-     * Raises a SafeInt to the power of another SafeInt.
-     *
-     * @example
-     *
-     * ```ts
-     * const base = asSafeInt(3);
-     *
-     * const exponent = asSafeInt(5);
-     *
-     * const power = SafeInt.pow(base, exponent);
-     *
-     * assert.isTrue(power === 243);
-     *
-     * assert.isTrue(SafeInt.is(power));
-     * ```
-     *
-     * @param a The base SafeInt.
-     * @param b The exponent SafeInt.
-     * @returns `a ** b` clamped to safe integer range as a SafeInt.
-     */
-    pow,
-    /**
-     * Adds two SafeInt values.
-     *
-     * @example
-     *
-     * ```ts
-     * const sum = SafeInt.add(asSafeInt(9), asSafeInt(4));
-     *
-     * assert.isTrue(sum === 13);
-     *
-     * assert.isTrue(SafeInt.is(sum));
-     * ```
-     *
-     * @param a The first SafeInt.
-     * @param b The second SafeInt.
-     * @returns `a + b` clamped to safe integer range as a SafeInt.
-     */
-    add,
-    /**
-     * Subtracts one SafeInt from another.
-     *
-     * @example
-     *
-     * ```ts
-     * const difference = SafeInt.sub(asSafeInt(9), asSafeInt(14));
-     *
-     * assert.isTrue(difference === -5);
-     *
-     * assert.isTrue(SafeInt.is(difference));
-     * ```
-     *
-     * @param a The minuend SafeInt.
-     * @param b The subtrahend SafeInt.
-     * @returns `a - b` clamped to safe integer range as a SafeInt.
-     */
-    sub,
-    /**
-     * Multiplies two SafeInt values.
-     *
-     * @example
-     *
-     * ```ts
-     * const product = SafeInt.mul(asSafeInt(-8), asSafeInt(7));
-     *
-     * assert.isTrue(product === -56);
-     *
-     * assert.isTrue(SafeInt.is(product));
-     * ```
-     *
-     * @param a The first SafeInt.
-     * @param b The second SafeInt.
-     * @returns `a * b` clamped to safe integer range as a SafeInt.
-     */
-    mul,
-    /**
-     * Divides one SafeInt by another using floor division.
-     *
-     * Performs mathematical floor division: `⌊a / b⌋`. The divisor must be
-     * non-zero (enforced by type constraints).
-     *
-     * @example
-     *
-     * ```ts
-     * const quotient = SafeInt.div(asSafeInt(-17), asSafeInt(5));
-     *
-     * assert.isTrue(quotient === -4);
-     *
-     * assert.isTrue(SafeInt.is(quotient));
-     * ```
-     *
-     * @param a - The dividend
-     * @param b - The divisor (must be non-zero)
-     * @returns The integer quotient as a SafeInt
-     */
-    div,
+  /**
+   * Type guard that checks if a value is a safe integer.
+   *
+   * @example
+   *
+   * ```ts
+   * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));
+   *
+   * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));
+   *
+   * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));
+   * ```
+   *
+   * @param value - The value to check
+   * @returns `true` if the value is a safe integer, `false` otherwise
+   * @see {@link isSafeInt} for usage examples
+   */
+  is,
+  /**
+   * The minimum safe integer value (-(2^53 - 1)).
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * The maximum safe integer value (2^53 - 1).
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the absolute value of a safe integer.
+   *
+   * Note: `Math.abs(MIN_SAFE_INTEGER)` would exceed `MAX_SAFE_INTEGER`, so this
+   * function clamps the result to maintain the safe integer guarantee.
+   *
+   * @example
+   *
+   * ```ts
+   * const negative = asSafeInt(-900);
+   *
+   * const absolute = SafeInt.abs(negative);
+   *
+   * assert.isTrue(absolute === 900);
+   *
+   * assert.isTrue(SafeInt.is(absolute));
+   * ```
+   *
+   * @param a - The safe integer value
+   * @returns The absolute value as a SafeInt, clamped if necessary
+   */
+  abs,
+  /**
+   * Returns the minimum value from a list of safe integers.
+   *
+   * @example
+   *
+   * ```ts
+   * const smallest = SafeInt.min(asSafeInt(25), asSafeInt(-14), asSafeInt(99));
+   *
+   * assert.isTrue(smallest === -14);
+   * ```
+   *
+   * @param values - The safe integers to compare (at least one required)
+   * @returns The smallest value as a SafeInt
+   */
+  min: min_,
+  /**
+   * Returns the maximum value from a list of safe integers.
+   *
+   * @example
+   *
+   * ```ts
+   * const largest = SafeInt.max(asSafeInt(25), asSafeInt(-14), asSafeInt(99));
+   *
+   * assert.isTrue(largest === 99);
+   * ```
+   *
+   * @param values - The safe integers to compare (at least one required)
+   * @returns The largest value as a SafeInt
+   */
+  max: max_,
+  /**
+   * Clamps a number to the safe integer range.
+   *
+   * @example
+   *
+   * ```ts
+   * const aboveRange = SafeInt.clamp(1e20);
+   *
+   * const withinRange = SafeInt.clamp(123);
+   *
+   * const belowRange = SafeInt.clamp(-1e20);
+   *
+   * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
+   *
+   * assert.isTrue(withinRange === 123);
+   *
+   * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);
+   * ```
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] as a
+   *   SafeInt.
+   */
+  clamp,
+  /**
+   * Generates a random safe integer within the specified range (inclusive).
+   *
+   * The range is inclusive on both ends. If min > max, they are automatically
+   * swapped.
+   *
+   * @example
+   *
+   * ```ts
+   * const min = asSafeInt(-10);
+   *
+   * const max = asSafeInt(10);
+   *
+   * const randomValue = SafeInt.random(min, max);
+   *
+   * assert.isTrue(SafeInt.is(randomValue));
+   *
+   * assert.isTrue(randomValue >= -10 && randomValue <= 10);
+   * ```
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random SafeInt in the range [min, max]
+   */
+  random,
+  /**
+   * Raises a SafeInt to the power of another SafeInt.
+   *
+   * @example
+   *
+   * ```ts
+   * const base = asSafeInt(3);
+   *
+   * const exponent = asSafeInt(5);
+   *
+   * const power = SafeInt.pow(base, exponent);
+   *
+   * assert.isTrue(power === 243);
+   *
+   * assert.isTrue(SafeInt.is(power));
+   * ```
+   *
+   * @param a The base SafeInt.
+   * @param b The exponent SafeInt.
+   * @returns `a ** b` clamped to safe integer range as a SafeInt.
+   */
+  pow,
+  /**
+   * Adds two SafeInt values.
+   *
+   * @example
+   *
+   * ```ts
+   * const sum = SafeInt.add(asSafeInt(9), asSafeInt(4));
+   *
+   * assert.isTrue(sum === 13);
+   *
+   * assert.isTrue(SafeInt.is(sum));
+   * ```
+   *
+   * @param a The first SafeInt.
+   * @param b The second SafeInt.
+   * @returns `a + b` clamped to safe integer range as a SafeInt.
+   */
+  add,
+  /**
+   * Subtracts one SafeInt from another.
+   *
+   * @example
+   *
+   * ```ts
+   * const difference = SafeInt.sub(asSafeInt(9), asSafeInt(14));
+   *
+   * assert.isTrue(difference === -5);
+   *
+   * assert.isTrue(SafeInt.is(difference));
+   * ```
+   *
+   * @param a The minuend SafeInt.
+   * @param b The subtrahend SafeInt.
+   * @returns `a - b` clamped to safe integer range as a SafeInt.
+   */
+  sub,
+  /**
+   * Multiplies two SafeInt values.
+   *
+   * @example
+   *
+   * ```ts
+   * const product = SafeInt.mul(asSafeInt(-8), asSafeInt(7));
+   *
+   * assert.isTrue(product === -56);
+   *
+   * assert.isTrue(SafeInt.is(product));
+   * ```
+   *
+   * @param a The first SafeInt.
+   * @param b The second SafeInt.
+   * @returns `a * b` clamped to safe integer range as a SafeInt.
+   */
+  mul,
+  /**
+   * Divides one SafeInt by another using floor division.
+   *
+   * Performs mathematical floor division: `⌊a / b⌋`. The divisor must be
+   * non-zero (enforced by type constraints).
+   *
+   * @example
+   *
+   * ```ts
+   * const quotient = SafeInt.div(asSafeInt(-17), asSafeInt(5));
+   *
+   * assert.isTrue(quotient === -4);
+   *
+   * assert.isTrue(SafeInt.is(quotient));
+   * ```
+   *
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The integer quotient as a SafeInt
+   */
+  div
 };
 
 export { SafeInt, asSafeInt, isSafeInt };

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

@@ -1 +1 @@
-{"version":3,"file":"safe-int.mjs","sources":["../../../src/number/branded-types/safe-int.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAWA,MAAM,iBAAiB,GAAG,gBAAgB;AAE1C,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,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;;IAEnC,SAAS,EAAE,MAAM,CAAC,gBAA2B;;IAE7C,SAAS,EAAE,MAAM,CAAC,gBAA4B;IAC9C,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;;;;;;;;;;;;;AAkBG;AACI,MAAM,SAAS,GAAG;AAEzB;;;;;;;;;;;;;;;;;;;;AAoBG;AACI,MAAM,SAAS,GAAG;AAEzB;;;;;;;;;;;;;;;AAeG;AACI,MAAM,OAAO,GAAG;AACrB;;;;;;;;;;;;;;;;AAgBG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;;;;;;;;;;;;;;;;AAoBG;IACH,GAAG;AAEH;;;;;;;;;;;;;AAaG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;;;;;;;AAaG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;;;;;;;;;;;;;;;;AAsBG;IACH,KAAK;AAEL;;;;;;;;;;;;;;;;;;;;;;;AAuBG;IACH,MAAM;AAEN;;;;;;;;;;;;;;;;;;;;AAoBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;AAgBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;AAgBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;AAgBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;;;;AAmBG;IACH,GAAG;;;;;"}
+{"version":3,"file":"safe-int.mjs","sources":["../../../src/number/branded-types/safe-int.mts"],"sourcesContent":["import {\n  type SafeUint,\n  type SafeInt as TtfImported_SafeInt,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type SafeInt = TtfImported_SafeInt;\n\ntype ElementType = SafeInt;\n\nconst typeNameInMessage = 'a safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  abs,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  SafeInt,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer\n  MIN_VALUE: Number.MIN_SAFE_INTEGER as SafeInt,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a safe integer.\n *\n * A safe integer is an integer that can be exactly represented in JavaScript\n * without precision loss. The range is [±(2^53 - 1)].\n *\n * @example\n *\n * ```ts\n * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));\n *\n * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));\n *\n * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is a safe integer, `false` otherwise\n */\nexport const isSafeInt = is;\n\n/**\n * Casts a number to a SafeInt branded type.\n *\n * This function validates that the input is a safe integer (within ±(2^53 - 1))\n * and returns it with the SafeInt brand. This ensures type safety for\n * operations that require precise integer arithmetic.\n *\n * @example\n *\n * ```ts\n * const branded = asSafeInt(123);\n *\n * assert.isTrue(branded === 123);\n *\n * assert.isTrue(SafeInt.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as a SafeInt branded type\n * @throws {TypeError} If the value is not a safe integer\n */\nexport const asSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for SafeInt branded types.\n *\n * SafeInt represents integers that can be exactly represented in JavaScript's\n * number type without precision loss. The range is [±(2^53 - 1)], which covers\n * approximately ±9 quadrillion.\n *\n * All operations automatically clamp results to stay within the safe range,\n * preventing precision loss that occurs with larger integers. This makes\n * SafeInt ideal for:\n *\n * - Financial calculations requiring exact cents\n * - Database IDs and counters\n * - Array indices and sizes\n * - Any integer arithmetic requiring precision guarantees\n */\nexport const SafeInt = {\n  /**\n   * Type guard that checks if a value is a safe integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isSafeInt(Number.MAX_SAFE_INTEGER));\n   *\n   * assert.isFalse(isSafeInt(Number.MAX_SAFE_INTEGER + 0.5));\n   *\n   * assert.isTrue(SafeInt.is(Number.MIN_SAFE_INTEGER));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a safe integer, `false` otherwise\n   * @see {@link isSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The minimum safe integer value (-(2^53 - 1)).\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 absolute value of a safe integer.\n   *\n   * Note: `Math.abs(MIN_SAFE_INTEGER)` would exceed `MAX_SAFE_INTEGER`, so this\n   * function clamps the result to maintain the safe integer guarantee.\n   *\n   * @example\n   *\n   * ```ts\n   * const negative = asSafeInt(-900);\n   *\n   * const absolute = SafeInt.abs(negative);\n   *\n   * assert.isTrue(absolute === 900);\n   *\n   * assert.isTrue(SafeInt.is(absolute));\n   * ```\n   *\n   * @param a - The safe integer value\n   * @returns The absolute value as a SafeInt, clamped if necessary\n   */\n  abs,\n\n  /**\n   * Returns the minimum value from a list of safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = SafeInt.min(asSafeInt(25), asSafeInt(-14), asSafeInt(99));\n   *\n   * assert.isTrue(smallest === -14);\n   * ```\n   *\n   * @param values - The safe integers to compare (at least one required)\n   * @returns The smallest value as a SafeInt\n   */\n  min: min_,\n\n  /**\n   * Returns the maximum value from a list of safe integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = SafeInt.max(asSafeInt(25), asSafeInt(-14), asSafeInt(99));\n   *\n   * assert.isTrue(largest === 99);\n   * ```\n   *\n   * @param values - The safe integers to compare (at least one required)\n   * @returns The largest value as a SafeInt\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the safe integer range.\n   *\n   * @example\n   *\n   * ```ts\n   * const aboveRange = SafeInt.clamp(1e20);\n   *\n   * const withinRange = SafeInt.clamp(123);\n   *\n   * const belowRange = SafeInt.clamp(-1e20);\n   *\n   * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);\n   *\n   * assert.isTrue(withinRange === 123);\n   *\n   * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);\n   * ```\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] as a\n   *   SafeInt.\n   */\n  clamp,\n\n  /**\n   * Generates a random safe integer within the specified range (inclusive).\n   *\n   * The range is inclusive on both ends. If min > max, they are automatically\n   * swapped.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asSafeInt(-10);\n   *\n   * const max = asSafeInt(10);\n   *\n   * const randomValue = SafeInt.random(min, max);\n   *\n   * assert.isTrue(SafeInt.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= -10 && randomValue <= 10);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random SafeInt in the range [min, max]\n   */\n  random,\n\n  /**\n   * Raises a SafeInt to the power of another SafeInt.\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asSafeInt(3);\n   *\n   * const exponent = asSafeInt(5);\n   *\n   * const power = SafeInt.pow(base, exponent);\n   *\n   * assert.isTrue(power === 243);\n   *\n   * assert.isTrue(SafeInt.is(power));\n   * ```\n   *\n   * @param a The base SafeInt.\n   * @param b The exponent SafeInt.\n   * @returns `a ** b` clamped to safe integer range as a SafeInt.\n   */\n  pow,\n\n  /**\n   * Adds two SafeInt values.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = SafeInt.add(asSafeInt(9), asSafeInt(4));\n   *\n   * assert.isTrue(sum === 13);\n   *\n   * assert.isTrue(SafeInt.is(sum));\n   * ```\n   *\n   * @param a The first SafeInt.\n   * @param b The second SafeInt.\n   * @returns `a + b` clamped to safe integer range as a SafeInt.\n   */\n  add,\n\n  /**\n   * Subtracts one SafeInt from another.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = SafeInt.sub(asSafeInt(9), asSafeInt(14));\n   *\n   * assert.isTrue(difference === -5);\n   *\n   * assert.isTrue(SafeInt.is(difference));\n   * ```\n   *\n   * @param a The minuend SafeInt.\n   * @param b The subtrahend SafeInt.\n   * @returns `a - b` clamped to safe integer range as a SafeInt.\n   */\n  sub,\n\n  /**\n   * Multiplies two SafeInt values.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = SafeInt.mul(asSafeInt(-8), asSafeInt(7));\n   *\n   * assert.isTrue(product === -56);\n   *\n   * assert.isTrue(SafeInt.is(product));\n   * ```\n   *\n   * @param a The first SafeInt.\n   * @param b The second SafeInt.\n   * @returns `a * b` clamped to safe integer range as a SafeInt.\n   */\n  mul,\n\n  /**\n   * Divides one SafeInt by another using floor division.\n   *\n   * Performs mathematical floor division: `⌊a / b⌋`. The divisor must be\n   * non-zero (enforced by type constraints).\n   *\n   * @example\n   *\n   * ```ts\n   * const quotient = SafeInt.div(asSafeInt(-17), asSafeInt(5));\n   *\n   * assert.isTrue(quotient === -4);\n   *\n   * assert.isTrue(SafeInt.is(quotient));\n   * ```\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The integer quotient as a SafeInt\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof SafeInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof SafeInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,gBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA;AAAA,EAEtB,WAAW,MAAA,CAAO,gBAAA;AAAA;AAAA,EAElB,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAqBH,MAAM,SAAA,GAAY;AAuBlB,MAAM,SAAA,GAAY;AAkBlB,MAAM,OAAA,GAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBrB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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;AAAA;AAAA;AAAA,EAuBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0BA,MAAA;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,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA;AACF;;;;"}

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

@@ -15,14 +15,14 @@ export declare const isSafeUint: (a: number) => a is TtfImported_SafeUint;
  * @throws {TypeError} If the value is not a non-negative safe integer.
  */
 export declare const asSafeUint: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
     readonly "> -2^16": true;
     readonly "> -2^32": true;
     readonly ">= -2^15": true;
     readonly ">= -2^31": true;
     readonly ">=0": true;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
     readonly SafeInt: true;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
@@ -126,16 +126,16 @@ export declare const SafeUint: {
      * @param b The divisor SafeUint.
      * @returns `⌊a / b⌋` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
      */
-    readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>, 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_SafeUint>, 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^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
-        readonly "!=0": true;
+        readonly Finite: true;
+        readonly Int: true;
+        readonly NaNValue: false;
         readonly SafeInt: true;
     } & Readonly<{
         'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;