ts-data-forge 14.6.0 → 14.6.2

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

@@ -1,135 +1,145 @@
-import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = "an integer in [-2^15, 2^15)";
-const {
-  MAX_VALUE,
-  MIN_VALUE,
-  abs,
-  add,
-  castType,
-  div,
-  fromNumber,
-  is,
-  max: max_,
-  min: min_,
-  mul,
-  pow,
-  random,
-  sub
-} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-  integerOrSafeInteger: "SafeInteger",
-  MIN_VALUE: -32768,
-  MAX_VALUE: 2 ** 15 - 1,
-  typeNameInMessage
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+const typeNameInMessage = 'an integer in [-2^15, 2^15)';
+const { MAX_VALUE, MIN_VALUE, abs, add, castType, div, fromNumber, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+    integerOrSafeInteger: 'SafeInteger',
+    MIN_VALUE: -(2 ** 15),
+    MAX_VALUE: 2 ** 15 - 1,
+    typeNameInMessage,
 });
-const isInt16 = is;
-const asInt16 = castType;
-const 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 an integer in [-2^15, 2^15), `false` otherwise
-   * @see {@link isInt16} for usage examples
-   */
-  is,
-  /**
-   * The smallest value representable as `Int16` (the lower saturation target of
-   * `fromNumber`).
-   */
-  MIN_VALUE,
-  /**
-   * The largest value representable as `Int16` (the upper saturation target of
-   * `fromNumber`).
-   */
-  MAX_VALUE,
-  /**
-   * 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 integer value
-   * @returns The absolute value as a non-negative `Int16`
-   */
-  abs,
-  /**
-   * Returns the smallest of the given integers.
-   *
-   * @param values - The integers to compare (at least one required)
-   * @returns The smallest value as an `Int16`
-   */
-  min: min_,
-  /**
-   * Returns the largest of the given integers.
-   *
-   * @param values - The integers to compare (at least one required)
-   * @returns The largest value as an `Int16`
-   */
-  max: max_,
-  /**
-   * 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 value to convert
-   * @returns The value as an `Int16`
-   */
-  fromNumber,
-  /**
-   * Generates a random `Int16` within the given range.
-   *
-   * The range is inclusive on both ends.
-   *
-   * @param min - The minimum value (inclusive)
-   * @param max - The maximum value (inclusive)
-   * @returns A random `Int16` in `[min, max]`
-   */
-  random,
-  /**
-   * Raises `a` to the power `b`, returning `a ** b` as an `Int16` (floored to
-   * an integer).
-   *
-   * @param a - The base integer
-   * @param b - The exponent integer
-   * @returns `a ** b` as an `Int16`
-   */
-  pow,
-  /**
-   * Adds two integers, returning `a + b` 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 two integers, returning `a - b` 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 integers, returning `a * b` 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 two integers using floor division (`⌊a / b⌋`): the result is `a /
-   * b` rounded toward negative infinity, as an `Int16`.
-   *
-   * @param a - The dividend
-   * @param b - The divisor (must be non-zero)
-   * @returns The floored quotient as an `Int16`
-   */
-  div
+/**
+ * Type guard that checks if a value is an integer in [-2^15, 2^15).
+ *
+ * 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 const isInt16 = is;
+/**
+ * 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`
+ * @throws {TypeError} If the value is not an integer in [-2^15, 2^15)
+ */
+export const asInt16 = castType;
+/**
+ * Namespace providing type-safe operations for the `Int16` branded type.
+ *
+ * The `Int16` type represents an integer in [-2^15, 2^15). Division (`div`)
+ * uses floor division.
+ */
+export const 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 an integer in [-2^15, 2^15), `false` otherwise
+     * @see {@link isInt16} for usage examples
+     */
+    is,
+    /**
+     * The smallest value representable as `Int16` (the lower saturation target of
+     * `fromNumber`).
+     */
+    MIN_VALUE,
+    /**
+     * The largest value representable as `Int16` (the upper saturation target of
+     * `fromNumber`).
+     */
+    MAX_VALUE,
+    /**
+     * 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 integer value
+     * @returns The absolute value as a non-negative `Int16`
+     */
+    abs,
+    /**
+     * Returns the smallest of the given integers.
+     *
+     * @param values - The integers to compare (at least one required)
+     * @returns The smallest value as an `Int16`
+     */
+    min: min_,
+    /**
+     * Returns the largest of the given integers.
+     *
+     * @param values - The integers to compare (at least one required)
+     * @returns The largest value as an `Int16`
+     */
+    max: max_,
+    /**
+     * 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 value to convert
+     * @returns The value as an `Int16`
+     */
+    fromNumber,
+    /**
+     * Generates a random `Int16` within the given range.
+     *
+     * The range is inclusive on both ends.
+     *
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `Int16` in `[min, max]`
+     */
+    random,
+    /**
+     * Raises `a` to the power `b`, returning `a ** b` as an `Int16` (floored to
+     * an integer).
+     *
+     * @param a - The base integer
+     * @param b - The exponent integer
+     * @returns `a ** b` as an `Int16`
+     */
+    pow,
+    /**
+     * Adds two integers, returning `a + b` 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 two integers, returning `a - b` 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 integers, returning `a * b` 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 two integers using floor division (`⌊a / b⌋`): the result is `a /
+     * b` rounded toward negative infinity, as an `Int16`.
+     *
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as an `Int16`
+     */
+    div,
 };
 
-export { Int16, asInt16, isInt16 };
-//# sourceMappingURL=int16.mjs.map
+
+//# sourceMappingURL=int16.mjs.map

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  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;;;;"}
+{"version":3,"file":"int16.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/int16.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AAExD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,GAAG,EACH,QAAQ,EACR,GAAG,EACH,UAAU,EACV,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,aAAa;IACnC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACrB,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;CACT,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,EAAE,CAAC;AAE1B;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;;;;;OAMG;IACH,EAAE;IAEF;;;OAGG;IACH,SAAS;IAET;;;OAGG;IACH,SAAS;IAET;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;OASG;IACH,UAAU;IAEV;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;OAMG;IACH,GAAG;IAEH;;;;;;OAMG;IACH,GAAG;IAEH;;;;;;OAMG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAMR,GAAG,CAAC,CAAC;AAEP,UAAU,CAMR,IAAI,CAAC,CAAC"}

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

@@ -1,135 +1,145 @@
-import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = "an integer in [-2^31, 2^31)";
-const {
-  MAX_VALUE,
-  MIN_VALUE,
-  abs,
-  add,
-  castType,
-  div,
-  fromNumber,
-  is,
-  max: max_,
-  min: min_,
-  mul,
-  pow,
-  random,
-  sub
-} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-  integerOrSafeInteger: "SafeInteger",
-  MIN_VALUE: -2147483648,
-  MAX_VALUE: 2 ** 31 - 1,
-  typeNameInMessage
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+const typeNameInMessage = 'an integer in [-2^31, 2^31)';
+const { MAX_VALUE, MIN_VALUE, abs, add, castType, div, fromNumber, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+    integerOrSafeInteger: 'SafeInteger',
+    MIN_VALUE: -(2 ** 31),
+    MAX_VALUE: 2 ** 31 - 1,
+    typeNameInMessage,
 });
-const isInt32 = is;
-const asInt32 = castType;
-const Int32 = {
-  /**
-   * Type guard that checks if a value is an integer in [-2^31, 2^31).
-   *
-   * @param value - The value to check
-   * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise
-   * @see {@link isInt32} for usage examples
-   */
-  is,
-  /**
-   * The smallest value representable as `Int32` (the lower saturation target of
-   * `fromNumber`).
-   */
-  MIN_VALUE,
-  /**
-   * The largest value representable as `Int32` (the upper saturation target of
-   * `fromNumber`).
-   */
-  MAX_VALUE,
-  /**
-   * Returns the absolute value of an integer in [-2^31, 2^31).
-   *
-   * The result is non-negative and keeps the `Int32` brand.
-   *
-   * @param a - The integer value
-   * @returns The absolute value as a non-negative `Int32`
-   */
-  abs,
-  /**
-   * Returns the smallest of the given integers.
-   *
-   * @param values - The integers to compare (at least one required)
-   * @returns The smallest value as an `Int32`
-   */
-  min: min_,
-  /**
-   * Returns the largest of the given integers.
-   *
-   * @param values - The integers to compare (at least one required)
-   * @returns The largest value as an `Int32`
-   */
-  max: max_,
-  /**
-   * Converts an arbitrary `number` into an `Int32`, rounding to the nearest
-   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
-   *
-   * Unlike `asInt32`, this is total: out-of-range inputs are clamped to the
-   * nearest representable `Int32` instead of throwing.
-   *
-   * @param value - The value to convert
-   * @returns The value as an `Int32`
-   */
-  fromNumber,
-  /**
-   * Generates a random `Int32` within the given range.
-   *
-   * The range is inclusive on both ends.
-   *
-   * @param min - The minimum value (inclusive)
-   * @param max - The maximum value (inclusive)
-   * @returns A random `Int32` in `[min, max]`
-   */
-  random,
-  /**
-   * Raises `a` to the power `b`, returning `a ** b` as an `Int32` (floored to
-   * an integer).
-   *
-   * @param a - The base integer
-   * @param b - The exponent integer
-   * @returns `a ** b` as an `Int32`
-   */
-  pow,
-  /**
-   * Adds two integers, returning `a + b` as an `Int32`.
-   *
-   * @param a - The first integer
-   * @param b - The second integer
-   * @returns The sum of `a` and `b` as an `Int32`
-   */
-  add,
-  /**
-   * Subtracts two integers, returning `a - b` as an `Int32`.
-   *
-   * @param a - The first integer
-   * @param b - The second integer
-   * @returns The difference of `a` and `b` as an `Int32`
-   */
-  sub,
-  /**
-   * Multiplies two integers, returning `a * b` as an `Int32`.
-   *
-   * @param a - The first integer
-   * @param b - The second integer
-   * @returns The product of `a` and `b` as an `Int32`
-   */
-  mul,
-  /**
-   * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
-   * b` rounded toward negative infinity, as an `Int32`.
-   *
-   * @param a - The dividend
-   * @param b - The divisor (must be non-zero)
-   * @returns The floored quotient as an `Int32`
-   */
-  div
+/**
+ * Type guard that checks if a value is an integer in [-2^31, 2^31).
+ *
+ * Returns `true` for an integer in [-2^31, 2^31) — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise
+ */
+export const isInt32 = is;
+/**
+ * Casts a `number` to the `Int32` branded type.
+ *
+ * Validates that the value is an integer in [-2^31, 2^31) and returns it with
+ * the `Int32` brand. Throws a `TypeError` otherwise.
+ *
+ * @param value - The value to cast
+ * @returns The value as an `Int32`
+ * @throws {TypeError} If the value is not an integer in [-2^31, 2^31)
+ */
+export const asInt32 = castType;
+/**
+ * Namespace providing type-safe operations for the `Int32` branded type.
+ *
+ * The `Int32` type represents an integer in [-2^31, 2^31). Division (`div`)
+ * uses floor division.
+ */
+export const Int32 = {
+    /**
+     * Type guard that checks if a value is an integer in [-2^31, 2^31).
+     *
+     * @param value - The value to check
+     * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise
+     * @see {@link isInt32} for usage examples
+     */
+    is,
+    /**
+     * The smallest value representable as `Int32` (the lower saturation target of
+     * `fromNumber`).
+     */
+    MIN_VALUE,
+    /**
+     * The largest value representable as `Int32` (the upper saturation target of
+     * `fromNumber`).
+     */
+    MAX_VALUE,
+    /**
+     * Returns the absolute value of an integer in [-2^31, 2^31).
+     *
+     * The result is non-negative and keeps the `Int32` brand.
+     *
+     * @param a - The integer value
+     * @returns The absolute value as a non-negative `Int32`
+     */
+    abs,
+    /**
+     * Returns the smallest of the given integers.
+     *
+     * @param values - The integers to compare (at least one required)
+     * @returns The smallest value as an `Int32`
+     */
+    min: min_,
+    /**
+     * Returns the largest of the given integers.
+     *
+     * @param values - The integers to compare (at least one required)
+     * @returns The largest value as an `Int32`
+     */
+    max: max_,
+    /**
+     * Converts an arbitrary `number` into an `Int32`, rounding to the nearest
+     * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+     *
+     * Unlike `asInt32`, this is total: out-of-range inputs are clamped to the
+     * nearest representable `Int32` instead of throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as an `Int32`
+     */
+    fromNumber,
+    /**
+     * Generates a random `Int32` within the given range.
+     *
+     * The range is inclusive on both ends.
+     *
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `Int32` in `[min, max]`
+     */
+    random,
+    /**
+     * Raises `a` to the power `b`, returning `a ** b` as an `Int32` (floored to
+     * an integer).
+     *
+     * @param a - The base integer
+     * @param b - The exponent integer
+     * @returns `a ** b` as an `Int32`
+     */
+    pow,
+    /**
+     * Adds two integers, returning `a + b` as an `Int32`.
+     *
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The sum of `a` and `b` as an `Int32`
+     */
+    add,
+    /**
+     * Subtracts two integers, returning `a - b` as an `Int32`.
+     *
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The difference of `a` and `b` as an `Int32`
+     */
+    sub,
+    /**
+     * Multiplies two integers, returning `a * b` as an `Int32`.
+     *
+     * @param a - The first integer
+     * @param b - The second integer
+     * @returns The product of `a` and `b` as an `Int32`
+     */
+    mul,
+    /**
+     * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
+     * b` rounded toward negative infinity, as an `Int32`.
+     *
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as an `Int32`
+     */
+    div,
 };
 
-export { Int32, asInt32, isInt32 };
-//# sourceMappingURL=int32.mjs.map
+
+//# sourceMappingURL=int32.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"int32.mjs","sources":["../../../src/number/branded-types/int32.mts"],"sourcesContent":["import { type Int32 as TtfImported_Int32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type Int32 = TtfImported_Int32;\n\ntype ElementType = Int32;\n\nconst typeNameInMessage = 'an integer in [-2^31, 2^31)';\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 ** 31),\n  MAX_VALUE: 2 ** 31 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is an integer in [-2^31, 2^31).\n *\n * Returns `true` for an integer in [-2^31, 2^31) — 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^31, 2^31), `false` otherwise\n */\nexport const isInt32 = is;\n\n/**\n * Casts a `number` to the `Int32` branded type.\n *\n * Validates that the value is an integer in [-2^31, 2^31) and returns it with\n * the `Int32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as an `Int32`\n * @throws {TypeError} If the value is not an integer in [-2^31, 2^31)\n */\nexport const asInt32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `Int32` branded type.\n *\n * The `Int32` type represents an integer in [-2^31, 2^31). Division (`div`)\n * uses floor division.\n */\nexport const Int32 = {\n  /**\n   * Type guard that checks if a value is an integer in [-2^31, 2^31).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is an integer in [-2^31, 2^31), `false` otherwise\n   * @see {@link isInt32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `Int32` (the lower saturation target of\n   * `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `Int32` (the upper saturation target of\n   * `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of an integer in [-2^31, 2^31).\n   *\n   * The result is non-negative and keeps the `Int32` brand.\n   *\n   * @param a - The integer value\n   * @returns The absolute value as a non-negative `Int32`\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 `Int32`\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 `Int32`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into an `Int32`, rounding to the nearest\n   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asInt32`, this is total: out-of-range inputs are clamped to the\n   * nearest representable `Int32` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as an `Int32`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `Int32` 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 `Int32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as an `Int32` (floored to\n   * an integer).\n   *\n   * @param a - The base integer\n   * @param b - The exponent integer\n   * @returns `a ** b` as an `Int32`\n   */\n  pow,\n\n  /**\n   * Adds two integers, returning `a + b` as an `Int32`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The sum of `a` and `b` as an `Int32`\n   */\n  add,\n\n  /**\n   * Subtracts two integers, returning `a - b` as an `Int32`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The difference of `a` and `b` as an `Int32`\n   */\n  sub,\n\n  /**\n   * Multiplies two integers, returning `a * b` as an `Int32`.\n   *\n   * @param a - The first integer\n   * @param b - The second integer\n   * @returns The product of `a` and `b` as an `Int32`\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 `Int32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as an `Int32`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof Int32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof Int32,\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,WAAO;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;;;;"}
+{"version":3,"file":"int32.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/int32.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AAExD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,GAAG,EACH,QAAQ,EACR,GAAG,EACH,UAAU,EACV,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,aAAa;IACnC,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACrB,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;CACT,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,EAAE,CAAC;AAE1B;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC;AAEhC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;;;;;OAMG;IACH,EAAE;IAEF;;;OAGG;IACH,SAAS;IAET;;;OAGG;IACH,SAAS;IAET;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;OASG;IACH,UAAU;IAEV;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;OAMG;IACH,GAAG;IAEH;;;;;;OAMG;IACH,GAAG;IAEH;;;;;;OAMG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAMR,GAAG,CAAC,CAAC;AAEP,UAAU,CAMR,IAAI,CAAC,CAAC"}