ts-data-forge 11.0.0 → 12.0.0

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

@@ -43,9 +43,9 @@ const Int = {
   /**
    * Returns the absolute value of an integer.
    *
-   * The result is always non-negative and maintains the Int brand. Note that
-   * Math.abs(Number.MIN_SAFE_INTEGER) exceeds Number.MAX_SAFE_INTEGER, so use
-   * SafeInt for guaranteed precision.
+   * 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
    *
@@ -60,11 +60,11 @@ const Int = {
    * ```
    *
    * @param a - The integer value
-   * @returns The absolute value as a non-negative Int
+   * @returns The absolute value as a non-negative `Int`
    */
   abs,
   /**
-   * Returns the minimum value from a list of integers.
+   * Returns the smallest of the given integers.
    *
    * @example
    *
@@ -75,11 +75,11 @@ const Int = {
    * ```
    *
    * @param values - The integers to compare (at least one required)
-   * @returns The smallest value as an Int
+   * @returns The smallest value as an `Int`
    */
   min: min_,
   /**
-   * Returns the maximum value from a list of integers.
+   * Returns the largest of the given integers.
    *
    * @example
    *
@@ -90,14 +90,13 @@ const Int = {
    * ```
    *
    * @param values - The integers to compare (at least one required)
-   * @returns The largest value as an Int
+   * @returns The largest value as an `Int`
    */
   max: max_,
   /**
-   * Generates a random integer within the specified range (inclusive).
+   * Generates a random `Int` within the given range.
    *
-   * The range is inclusive on both ends, so random(1, 6) can return any of: 1,
-   * 2, 3, 4, 5, or 6.
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -115,11 +114,12 @@ const Int = {
    *
    * @param min - The minimum value (inclusive)
    * @param max - The maximum value (inclusive)
-   * @returns A random Int in the range [min, max]
+   * @returns A random `Int` in `[min, max]`
    */
   random,
   /**
-   * Raises an integer to a power.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Int` (floored to an
+   * integer).
    *
    * @example
    *
@@ -135,11 +135,11 @@ const Int = {
    *
    * @param a - The base integer
    * @param b - The exponent integer
-   * @returns `a ** b` as an Int
+   * @returns `a ** b` as an `Int`
    */
   pow,
   /**
-   * Adds two integers.
+   * Adds two integers, returning `a + b` as an `Int`.
    *
    * @example
    *
@@ -149,13 +149,13 @@ const Int = {
    * assert.isTrue(sum === 20);
    * ```
    *
-   * @param a - First integer
-   * @param b - Second integer
-   * @returns `a + b` as an Int
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The sum of `a` and `b` as an `Int`
    */
   add,
   /**
-   * Subtracts two integers.
+   * Subtracts two integers, returning `a - b` as an `Int`.
    *
    * @example
    *
@@ -165,13 +165,13 @@ const Int = {
    * assert.isTrue(difference === 4);
    * ```
    *
-   * @param a - First integer
-   * @param b - Second integer
-   * @returns `a - b` as an Int
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The difference of `a` and `b` as an `Int`
    */
   sub,
   /**
-   * Multiplies two integers.
+   * Multiplies two integers, returning `a * b` as an `Int`.
    *
    * @example
    *
@@ -181,16 +181,14 @@ const Int = {
    * assert.isTrue(product === -24);
    * ```
    *
-   * @param a - First integer
-   * @param b - Second integer
-   * @returns `a * b` as an Int
+   * @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.
-   *
-   * Performs mathematical floor division: `⌊a / b⌋`. The result is always an
-   * integer, rounding toward negative infinity.
+   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+   * b` rounded toward negative infinity, as an `Int`.
    *
    * @example
    *
@@ -206,7 +204,7 @@ const Int = {
    *
    * @param a - The dividend
    * @param b - The divisor (must be non-zero)
-   * @returns The integer quotient as an Int
+   * @returns The floored quotient as an `Int`
    */
   div
 };

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` if the value is any integer (positive, negative, or zero),\n * with no fractional component. This includes values outside the safe integer\n * 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 an Int branded type.\n *\n * This function validates that the input is an integer and returns it with the\n * Int brand. Throws a TypeError if the value has a fractional component or is\n * not a finite number.\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 branded type\n * @throws {TypeError} If the value is not an integer\n */\nexport const asInt = castType;\n\n/**\n * Namespace providing type-safe operations for Int branded types.\n *\n * The Int type represents any integer value (no fractional component) without\n * range restrictions. All operations preserve the integer constraint, using\n * floor division for division operations.\n *\n * Unlike SafeInt, Int allows values outside the safe integer range (±2^53 - 1),\n * but be aware that very large integers may lose precision in JavaScript's\n * number 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 always non-negative and maintains the Int brand. Note that\n   * Math.abs(Number.MIN_SAFE_INTEGER) exceeds Number.MAX_SAFE_INTEGER, so use\n   * 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 minimum value from a list of 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 maximum value from a list of 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 integer within the specified range (inclusive).\n   *\n   * The range is inclusive on both ends, so random(1, 6) can return any of: 1,\n   * 2, 3, 4, 5, or 6.\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 the range [min, max]\n   */\n  random,\n\n  /**\n   * Raises an integer to a power.\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.\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 - First integer\n   * @param b - Second integer\n   * @returns `a + b` as an Int\n   */\n  add,\n\n  /**\n   * Subtracts two integers.\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 - First integer\n   * @param b - Second integer\n   * @returns `a - b` as an Int\n   */\n  sub,\n\n  /**\n   * Multiplies two integers.\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 - First integer\n   * @param b - Second integer\n   * @returns `a * b` as an Int\n   */\n  mul,\n\n  /**\n   * Divides two integers using floor division.\n   *\n   * Performs mathematical floor division: `⌊a / b⌋`. The result is always an\n   * integer, rounding toward negative infinity.\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 integer 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;AAsBH,MAAM,KAAA,GAAQ;AAuBd,MAAM,KAAA,GAAQ;AAad,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;AAAA,EA0BL,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,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;AAAA;AAAA,EAwBA;AACF;;;;"}
+{"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;;;;"}

package/dist/number/branded-types/int16.d.mts

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

@@ -1 +1 @@
-{"version":3,"file":"int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,IAAI,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAIhE,MAAM,MAAM,KAAK,GAAG,iBAAiB,CAAC;AAgCtC;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,uCAAK,CAAC;AAE1B;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,IAAI,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAIhE,MAAM,MAAM,KAAK,GAAG,iBAAiB,CAAC;AAgCtC;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,uCAAK,CAAC;AAE1B;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;;;OAOG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;OASG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}

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

@@ -7,8 +7,8 @@ const {
   abs,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -26,98 +26,107 @@ const isInt16 = is;
 const asInt16 = castType;
 const Int16 = {
   /**
-   * Type guard to check if a value is an Int16.
+   * Type guard that checks if a value is an integer in [-2^15, 2^15).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 16-bit signed integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is an integer in [-2^15, 2^15), `false` otherwise
+   * @see {@link isInt16} for usage examples
    */
   is,
   /**
-   * The minimum value for a 16-bit signed integer.
-   *
-   * @readonly
+   * The smallest value representable as `Int16` (the lower saturation target of
+   * `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 16-bit signed integer.
-   *
-   * @readonly
+   * The largest value representable as `Int16` (the upper saturation target of
+   * `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * Returns the absolute value of a 16-bit signed integer.
+   * Returns the absolute value of an integer in [-2^15, 2^15).
+   *
+   * The result is non-negative and keeps the `Int16` brand.
    *
-   * @param a The Int16 value.
-   * @returns The absolute value as an Int16, clamped to valid range.
+   * @param a - The integer value
+   * @returns The absolute value as a non-negative `Int16`
    */
   abs,
   /**
-   * Returns the smaller of two Int16 values.
+   * Returns the smallest of the given integers.
    *
-   * @param a The first Int16.
-   * @param b The second Int16.
-   * @returns The minimum value as an Int16.
+   * @param values - The integers to compare (at least one required)
+   * @returns The smallest value as an `Int16`
    */
   min: min_,
   /**
-   * Returns the larger of two Int16 values.
+   * Returns the largest of the given integers.
    *
-   * @param a The first Int16.
-   * @param b The second Int16.
-   * @returns The maximum value as an Int16.
+   * @param values - The integers to compare (at least one required)
+   * @returns The largest value as an `Int16`
    */
   max: max_,
   /**
-   * Clamps a number to the Int16 range.
+   * Converts an arbitrary `number` into an `Int16`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [-32768, 32767] as an Int16.
+   * Unlike `asInt16`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `Int16` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as an `Int16`
    */
-  clamp,
+  fromNumber,
   /**
-   * Generates a random Int16 value within the valid range.
+   * Generates a random `Int16` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random Int16 between MIN_VALUE and MAX_VALUE.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `Int16` in `[min, max]`
    */
   random,
   /**
-   * Raises an Int16 to the power of another Int16.
+   * Raises `a` to the power `b`, returning `a ** b` as an `Int16` (floored to
+   * an integer).
    *
-   * @param a The base Int16.
-   * @param b The exponent Int16.
-   * @returns `a ** b` clamped to [-32768, 32767] as an Int16.
+   * @param a - The base integer
+   * @param b - The exponent integer
+   * @returns `a ** b` as an `Int16`
    */
   pow,
   /**
-   * Adds two Int16 values.
+   * Adds two integers, returning `a + b` as an `Int16`.
    *
-   * @param a The first Int16.
-   * @param b The second Int16.
-   * @returns `a + b` clamped to [-32768, 32767] as an Int16.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The sum of `a` and `b` as an `Int16`
    */
   add,
   /**
-   * Subtracts one Int16 from another.
+   * Subtracts two integers, returning `a - b` as an `Int16`.
    *
-   * @param a The minuend Int16.
-   * @param b The subtrahend Int16.
-   * @returns `a - b` clamped to [-32768, 32767] as an Int16.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The difference of `a` and `b` as an `Int16`
    */
   sub,
   /**
-   * Multiplies two Int16 values.
+   * Multiplies two integers, returning `a * b` as an `Int16`.
    *
-   * @param a The first Int16.
-   * @param b The second Int16.
-   * @returns `a * b` clamped to [-32768, 32767] as an Int16.
+   * @param a - The first integer
+   * @param b - The second integer
+   * @returns The product of `a` and `b` as an `Int16`
    */
   mul,
   /**
-   * Divides one Int16 by another using floor division.
+   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+   * b` rounded toward negative infinity, as an `Int16`.
    *
-   * @param a The dividend Int16.
-   * @param b The divisor Int16.
-   * @returns `⌊a / b⌋` clamped to [-32768, 32767] as an Int16.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as an `Int16`
    */
   div
 };

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

@@ -1 +1 @@
-{"version":3,"file":"int16.mjs","sources":["../../../src/number/branded-types/int16.mts"],"sourcesContent":["import { type Int16 as TtfImported_Int16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Int16 = TtfImported_Int16;\n\ntype ElementType = Int16;\n\nconst typeNameInMessage = 'an integer in [-2^15, 2^15)';\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  number,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: -(2 ** 15),\n  MAX_VALUE: 2 ** 15 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is an Int16 (16-bit signed integer in the range [-2^15,\n * 2^15)).\n *\n * @param value The value to check.\n * @returns `true` if the value is an Int16, `false` otherwise.\n */\nexport const isInt16 = is;\n\n/**\n * Casts a number to an Int16 type.\n *\n * @param value The value to cast.\n * @returns The value as an Int16 type.\n * @throws {TypeError} If the value is not an integer in [-2^15, 2^15).\n */\nexport const asInt16 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 16-bit signed\n * integers.\n *\n * All operations automatically clamp results to the valid Int16 range [-32768,\n * 32767]. This ensures that all arithmetic maintains the 16-bit signed integer\n * constraint.\n */\nexport const Int16 = {\n  /**\n   * Type guard to check if a value is an Int16.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a 16-bit signed integer, `false` otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a 16-bit signed integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a 16-bit signed integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a 16-bit signed integer.\n   *\n   * @param a The Int16 value.\n   * @returns The absolute value as an Int16, clamped to valid range.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two Int16 values.\n   *\n   * @param a The first Int16.\n   * @param b The second Int16.\n   * @returns The minimum value as an Int16.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two Int16 values.\n   *\n   * @param a The first Int16.\n   * @param b The second Int16.\n   * @returns The maximum value as an Int16.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the Int16 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [-32768, 32767] as an Int16.\n   */\n  clamp,\n\n  /**\n   * Generates a random Int16 value within the valid range.\n   *\n   * @returns A random Int16 between MIN_VALUE and MAX_VALUE.\n   */\n  random,\n\n  /**\n   * Raises an Int16 to the power of another Int16.\n   *\n   * @param a The base Int16.\n   * @param b The exponent Int16.\n   * @returns `a ** b` clamped to [-32768, 32767] as an Int16.\n   */\n  pow,\n\n  /**\n   * Adds two Int16 values.\n   *\n   * @param a The first Int16.\n   * @param b The second Int16.\n   * @returns `a + b` clamped to [-32768, 32767] as an Int16.\n   */\n  add,\n\n  /**\n   * Subtracts one Int16 from another.\n   *\n   * @param a The minuend Int16.\n   * @param b The subtrahend Int16.\n   * @returns `a - b` clamped to [-32768, 32767] as an Int16.\n   */\n  sub,\n\n  /**\n   * Multiplies two Int16 values.\n   *\n   * @param a The first Int16.\n   * @param b The second Int16.\n   * @returns `a * b` clamped to [-32768, 32767] as an Int16.\n   */\n  mul,\n\n  /**\n   * Divides one Int16 by another using floor division.\n   *\n   * @param a The dividend Int16.\n   * @param b The divisor Int16.\n   * @returns `⌊a / b⌋` clamped to [-32768, 32767] as an Int16.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Int16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof Int16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,6BAAA;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,EACtB,SAAA,EAAW,MAAO;AAAA,EAClB,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AASH,MAAM,OAAA,GAAU;AAShB,MAAM,OAAA,GAAU;AAUhB,MAAM,KAAA,GAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}
+{"version":3,"file":"int16.mjs","sources":["../../../src/number/branded-types/int16.mts"],"sourcesContent":["import { type Int16 as TtfImported_Int16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Int16 = TtfImported_Int16;\n\ntype ElementType = Int16;\n\nconst typeNameInMessage = 'an integer in [-2^15, 2^15)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  abs,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: -(2 ** 15),\n  MAX_VALUE: 2 ** 15 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is an integer in [-2^15, 2^15).\n *\n * Returns `true` for an integer in [-2^15, 2^15) — a value with no fractional\n * component.\n *\n * @param value - The value to check\n * @returns `true` if the value is an integer in [-2^15, 2^15), `false` otherwise\n */\nexport const isInt16 = is;\n\n/**\n * Casts a `number` to the `Int16` branded type.\n *\n * Validates that the value is an integer in [-2^15, 2^15) and returns it with\n * the `Int16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as an `Int16`\n * @throws {TypeError} If the value is not an integer in [-2^15, 2^15)\n */\nexport const asInt16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `Int16` branded type.\n *\n * The `Int16` type represents an integer in [-2^15, 2^15). Division (`div`)\n * uses floor division.\n */\nexport const Int16 = {\n  /**\n   * Type guard that checks if a value is an integer in [-2^15, 2^15).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is an integer in [-2^15, 2^15), `false` otherwise\n   * @see {@link isInt16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `Int16` (the lower saturation target of\n   * `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `Int16` (the upper saturation target of\n   * `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of an integer in [-2^15, 2^15).\n   *\n   * The result is non-negative and keeps the `Int16` brand.\n   *\n   * @param a - The integer value\n   * @returns The absolute value as a non-negative `Int16`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given integers.\n   *\n   * @param values - The integers to compare (at least one required)\n   * @returns The smallest value as an `Int16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given integers.\n   *\n   * @param values - The integers to compare (at least one required)\n   * @returns The largest value as an `Int16`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into an `Int16`, rounding to the nearest\n   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asInt16`, this is total: out-of-range inputs are clamped to the\n   * nearest representable `Int16` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as an `Int16`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `Int16` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `Int16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as an `Int16` (floored to\n   * an integer).\n   *\n   * @param a - The base integer\n   * @param b - The exponent integer\n   * @returns `a ** b` as an `Int16`\n   */\n  pow,\n\n  /**\n   * Adds two integers, returning `a + b` as an `Int16`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The sum of `a` and `b` as an `Int16`\n   */\n  add,\n\n  /**\n   * Subtracts two integers, returning `a - b` as an `Int16`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The difference of `a` and `b` as an `Int16`\n   */\n  sub,\n\n  /**\n   * Multiplies two integers, returning `a * b` as an `Int16`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The product of `a` and `b` as an `Int16`\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 `Int16`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as an `Int16`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Int16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof Int16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,6BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,MAAO;AAAA,EAClB,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,OAAA,GAAU;AAYhB,MAAM,OAAA,GAAU;AAQhB,MAAM,KAAA,GAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}