ts-data-forge 14.6.1 → 14.6.3

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

@@ -1,213 +1,249 @@
-import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = "an integer";
-const {
-  abs,
-  add,
-  castType,
-  div,
-  is,
-  max: max_,
-  min: min_,
-  mul,
-  pow,
-  random,
-  sub
-} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-  integerOrSafeInteger: "Integer",
-  MIN_VALUE: -Number.MAX_VALUE,
-  MAX_VALUE: Number.MAX_VALUE,
-  typeNameInMessage
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+const typeNameInMessage = 'an integer';
+const { abs, add, castType, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+    integerOrSafeInteger: 'Integer',
+    MIN_VALUE: -Number.MAX_VALUE,
+    MAX_VALUE: Number.MAX_VALUE,
+    typeNameInMessage,
 });
-const isInt = is;
-const asInt = castType;
-const Int = {
-  /**
-   * Type guard that checks if a value is an integer.
-   *
-   * @example
-   *
-   * ```ts
-   * assert.isTrue(isInt(5));
-   *
-   * assert.isFalse(isInt(5.25));
-   *
-   * assert.isTrue(Int.is(-10));
-   * ```
-   *
-   * @param value - The value to check
-   * @returns `true` if the value is an integer, `false` otherwise
-   * @see {@link isInt} for usage examples
-   */
-  is,
-  /**
-   * Returns the absolute value of an integer.
-   *
-   * The result is non-negative and keeps the `Int` brand. Note that
-   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
-   * use `SafeInt` for guaranteed precision.
-   *
-   * @example
-   *
-   * ```ts
-   * const negative = asInt(-12);
-   *
-   * const absolute = Int.abs(negative);
-   *
-   * assert.isTrue(absolute === 12);
-   *
-   * assert.isTrue(Int.is(absolute));
-   * ```
-   *
-   * @param a - The integer value
-   * @returns The absolute value as a non-negative `Int`
-   */
-  abs,
-  /**
-   * Returns the smallest of the given integers.
-   *
-   * @example
-   *
-   * ```ts
-   * const smallest = Int.min(asInt(7), asInt(-3), asInt(2));
-   *
-   * assert.isTrue(smallest === -3);
-   * ```
-   *
-   * @param values - The integers to compare (at least one required)
-   * @returns The smallest value as an `Int`
-   */
-  min: min_,
-  /**
-   * Returns the largest of the given integers.
-   *
-   * @example
-   *
-   * ```ts
-   * const largest = Int.max(asInt(7), asInt(-3), asInt(2));
-   *
-   * assert.isTrue(largest === 7);
-   * ```
-   *
-   * @param values - The integers to compare (at least one required)
-   * @returns The largest value as an `Int`
-   */
-  max: max_,
-  /**
-   * Generates a random `Int` within the given range.
-   *
-   * The range is inclusive on both ends.
-   *
-   * @example
-   *
-   * ```ts
-   * const min = asInt(1);
-   *
-   * const max = asInt(6);
-   *
-   * const randomValue = Int.random(min, max);
-   *
-   * assert.isTrue(Int.is(randomValue));
-   *
-   * assert.isTrue(randomValue >= 1 && randomValue <= 6);
-   * ```
-   *
-   * @param min - The minimum value (inclusive)
-   * @param max - The maximum value (inclusive)
-   * @returns A random `Int` in `[min, max]`
-   */
-  random,
-  /**
-   * Raises `a` to the power `b`, returning `a ** b` as an `Int` (floored to an
-   * integer).
-   *
-   * @example
-   *
-   * ```ts
-   * const base = asInt(2);
-   *
-   * const exponent = asInt(5);
-   *
-   * const power = Int.pow(base, exponent);
-   *
-   * assert.isTrue(power === 32);
-   * ```
-   *
-   * @param a - The base integer
-   * @param b - The exponent integer
-   * @returns `a ** b` as an `Int`
-   */
-  pow,
-  /**
-   * Adds two integers, returning `a + b` as an `Int`.
-   *
-   * @example
-   *
-   * ```ts
-   * const sum = Int.add(asInt(12), asInt(8));
-   *
-   * assert.isTrue(sum === 20);
-   * ```
-   *
-   * @param a - The first integer
-   * @param b - The second integer
-   * @returns The sum of `a` and `b` as an `Int`
-   */
-  add,
-  /**
-   * Subtracts two integers, returning `a - b` as an `Int`.
-   *
-   * @example
-   *
-   * ```ts
-   * const difference = Int.sub(asInt(12), asInt(8));
-   *
-   * assert.isTrue(difference === 4);
-   * ```
-   *
-   * @param a - The first integer
-   * @param b - The second integer
-   * @returns The difference of `a` and `b` as an `Int`
-   */
-  sub,
-  /**
-   * Multiplies two integers, returning `a * b` as an `Int`.
-   *
-   * @example
-   *
-   * ```ts
-   * const product = Int.mul(asInt(-4), asInt(6));
-   *
-   * assert.isTrue(product === -24);
-   * ```
-   *
-   * @param a - The first integer
-   * @param b - The second integer
-   * @returns The product of `a` and `b` as an `Int`
-   */
-  mul,
-  /**
-   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
-   * b` rounded toward negative infinity, as an `Int`.
-   *
-   * @example
-   *
-   * ```ts
-   * const dividend = asInt(17);
-   *
-   * const divisor = asInt(5);
-   *
-   * const quotient = Int.div(dividend, divisor);
-   *
-   * assert.isTrue(quotient === 3);
-   * ```
-   *
-   * @param a - The dividend
-   * @param b - The divisor (must be non-zero)
-   * @returns The floored quotient as an `Int`
-   */
-  div
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+export const isInt = is;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+export const asInt = castType;
+
+
+
+
+
+
+
+
+
+export const Int = {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    is,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    abs,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    min: min_,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    max: max_,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    random,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    pow,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    add,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    sub,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    mul,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    div,
 };
 
-export { Int, asInt, isInt };
-//# sourceMappingURL=int.mjs.map
+
+//# sourceMappingURL=int.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"int.mjs","sources":["../../../src/number/branded-types/int.mts"],"sourcesContent":["import { type Int as TtfImported_Int } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Int = TtfImported_Int;\n\ntype ElementType = Int;\n\nconst typeNameInMessage = 'an integer';\n\nconst {\n  abs,\n  add,\n  castType,\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  number,\n  number\n>({\n  integerOrSafeInteger: 'Integer',\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is an integer.\n *\n * Returns `true` for an 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(isInt(5));\n *\n * assert.isFalse(isInt(5.25));\n *\n * assert.isTrue(Int.is(-10));\n * ```\n *\n * @param value - The value to check\n * @returns `true` if the value is an integer, `false` otherwise\n */\nexport const isInt = is;\n\n/**\n * Casts a `number` to the `Int` branded type.\n *\n * Validates that the value is an integer and returns it with the `Int` brand.\n * Throws a `TypeError` otherwise.\n *\n * @example\n *\n * ```ts\n * const branded = asInt(42);\n *\n * assert.isTrue(branded === 42);\n *\n * assert.isTrue(Int.is(branded));\n * ```\n *\n * @param value - The value to cast\n * @returns The value as an `Int`\n * @throws {TypeError} If the value is not an integer\n */\nexport const asInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `Int` branded type.\n *\n * The `Int` type represents an integer. Division (`div`) uses floor division.\n *\n * Unlike `SafeInt`, `Int` allows values outside the safe integer range (±2^53 −\n * 1), so very large magnitudes may lose precision in JavaScript's `number`\n * type.\n */\nexport const Int = {\n  /**\n   * Type guard that checks if a value is an integer.\n   *\n   * @example\n   *\n   * ```ts\n   * assert.isTrue(isInt(5));\n   *\n   * assert.isFalse(isInt(5.25));\n   *\n   * assert.isTrue(Int.is(-10));\n   * ```\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is an integer, `false` otherwise\n   * @see {@link isInt} for usage examples\n   */\n  is,\n\n  /**\n   * Returns the absolute value of an integer.\n   *\n   * The result is non-negative and keeps the `Int` brand. Note that\n   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so\n   * use `SafeInt` for guaranteed precision.\n   *\n   * @example\n   *\n   * ```ts\n   * const negative = asInt(-12);\n   *\n   * const absolute = Int.abs(negative);\n   *\n   * assert.isTrue(absolute === 12);\n   *\n   * assert.isTrue(Int.is(absolute));\n   * ```\n   *\n   * @param a - The integer value\n   * @returns The absolute value as a non-negative `Int`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const smallest = Int.min(asInt(7), asInt(-3), asInt(2));\n   *\n   * assert.isTrue(smallest === -3);\n   * ```\n   *\n   * @param values - The integers to compare (at least one required)\n   * @returns The smallest value as an `Int`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given integers.\n   *\n   * @example\n   *\n   * ```ts\n   * const largest = Int.max(asInt(7), asInt(-3), asInt(2));\n   *\n   * assert.isTrue(largest === 7);\n   * ```\n   *\n   * @param values - The integers to compare (at least one required)\n   * @returns The largest value as an `Int`\n   */\n  max: max_,\n\n  /**\n   * Generates a random `Int` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @example\n   *\n   * ```ts\n   * const min = asInt(1);\n   *\n   * const max = asInt(6);\n   *\n   * const randomValue = Int.random(min, max);\n   *\n   * assert.isTrue(Int.is(randomValue));\n   *\n   * assert.isTrue(randomValue >= 1 && randomValue <= 6);\n   * ```\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `Int` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as an `Int` (floored to an\n   * integer).\n   *\n   * @example\n   *\n   * ```ts\n   * const base = asInt(2);\n   *\n   * const exponent = asInt(5);\n   *\n   * const power = Int.pow(base, exponent);\n   *\n   * assert.isTrue(power === 32);\n   * ```\n   *\n   * @param a - The base integer\n   * @param b - The exponent integer\n   * @returns `a ** b` as an `Int`\n   */\n  pow,\n\n  /**\n   * Adds two integers, returning `a + b` as an `Int`.\n   *\n   * @example\n   *\n   * ```ts\n   * const sum = Int.add(asInt(12), asInt(8));\n   *\n   * assert.isTrue(sum === 20);\n   * ```\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The sum of `a` and `b` as an `Int`\n   */\n  add,\n\n  /**\n   * Subtracts two integers, returning `a - b` as an `Int`.\n   *\n   * @example\n   *\n   * ```ts\n   * const difference = Int.sub(asInt(12), asInt(8));\n   *\n   * assert.isTrue(difference === 4);\n   * ```\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The difference of `a` and `b` as an `Int`\n   */\n  sub,\n\n  /**\n   * Multiplies two integers, returning `a * b` as an `Int`.\n   *\n   * @example\n   *\n   * ```ts\n   * const product = Int.mul(asInt(-4), asInt(6));\n   *\n   * assert.isTrue(product === -24);\n   * ```\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The product of `a` and `b` as an `Int`\n   */\n  mul,\n\n  /**\n   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /\n   * b` rounded toward negative infinity, as an `Int`.\n   *\n   * @example\n   *\n   * ```ts\n   * const dividend = asInt(17);\n   *\n   * const divisor = asInt(5);\n   *\n   * const quotient = Int.div(dividend, divisor);\n   *\n   * assert.isTrue(quotient === 3);\n   * ```\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as an `Int`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Int,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int'>\n>('=');\n\nexpectType<\n  typeof Int,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int'>\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,YAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;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,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAqBH,MAAM,KAAA,GAAQ;AAsBd,MAAM,KAAA,GAAQ;AAWd,MAAM,GAAA,GAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBjB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,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,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA;AACF;;;;"}
+{"version":3,"file":"int.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/int.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAEvC,MAAM,EACJ,GAAG,EACH,GAAG,EACH,QAAQ,EACR,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;IACA,oBAAoB,EAAE,SAAS;IAC/B,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS;IAC5B,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,iBAAiB;CACT,CAAC,CAAC;AAEZ;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;AAExB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,QAAQ,CAAC;AAE9B;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG;IACjB;;;;;;;;;;;;;;;;OAgBG;IACH,EAAE;IAEF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,GAAG;IAEH;;;;;;;;;;;;;OAaG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;;;;;OAaG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM;IAEN;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG;IAEH;;;;;;;;;;;;;;OAcG;IACH,GAAG;IAEH;;;;;;;;;;;;;;OAcG;IACH,GAAG;IAEH;;;;;;;;;;;;;;OAcG;IACH,GAAG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAGR,GAAG,CAAC,CAAC;AAEP,UAAU,CAGR,IAAI,CAAC,CAAC"}