ts-data-forge 3.3.0 → 4.0.0

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

@@ -1,7 +1,7 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
 const typeNameInMessage = 'an integer';
-const { abs, min: min_, max: max_, pow, add, sub, mul, div, random, is, castType, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+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,
@@ -14,42 +14,37 @@ const { abs, min: min_, max: max_, pow, add, sub, mul, div, random, is, castType
  * with no fractional component. This includes values outside the safe integer
  * range, unlike SafeInt.
  *
- * @param value - The value to check
- * @returns `true` if the value is an integer, `false` otherwise
- *
  * @example
- * ```typescript
- * isInt(5);        // true
- * isInt(-10);      // true
- * isInt(0);        // true
- * isInt(5.5);      // false
- * isInt(NaN);      // false
- * isInt(Infinity); // false
+ *
+ * ```ts
+ * assert.ok(isInt(5));
+ * assert.notOk(isInt(5.25));
+ * assert.ok(Int.is(-10));
  * ```
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is an integer, `false` otherwise
  */
 const isInt = is;
 /**
  * Casts a number to an Int branded type.
  *
- * This function validates that the input is an integer and returns it with
- * the Int brand. Throws a TypeError if the value has a fractional component
- * or is not a finite number.
- *
- * @param value - The value to cast
- * @returns The value as an Int branded type
- * @throws {TypeError} If the value is not an integer
+ * This function validates that the input is an integer and returns it with the
+ * Int brand. Throws a TypeError if the value has a fractional component or is
+ * not a finite number.
  *
  * @example
- * ```typescript
- * const x = asInt(5);    // Int
- * const y = asInt(-10);  // Int
- * const z = asInt(0);    // Int
  *
- * // These throw TypeError:
- * // asInt(5.5);         // Not an integer
- * // asInt(NaN);         // Not a number
- * // asInt(Infinity);    // Not finite
+ * ```ts
+ * const branded = asInt(42);
+ *
+ * assert(branded === 42);
+ * assert.ok(Int.is(branded));
  * ```
+ *
+ * @param value - The value to cast
+ * @returns The value as an Int branded type
+ * @throws {TypeError} If the value is not an integer
  */
 const asInt = castType;
 /**
@@ -59,178 +54,185 @@ const asInt = castType;
  * range restrictions. All operations preserve the integer constraint, using
  * floor division for division operations.
  *
- * Unlike SafeInt, Int allows values outside the safe integer range
- * (±2^53 - 1), but be aware that very large integers may lose precision
- * in JavaScript's number type.
- *
- * @example
- * ```typescript
- * // Type validation
- * Int.is(42);      // true
- * Int.is(3.14);    // false
- * Int.is(-0);      // true (negative zero is an integer)
- *
- * // Basic arithmetic
- * const a = asInt(10);
- * const b = asInt(3);
- *
- * const sum = Int.add(a, b);      // Int (13)
- * const diff = Int.sub(a, b);     // Int (7)
- * const product = Int.mul(a, b);  // Int (30)
- * const quotient = Int.div(a, b); // Int (3) - floor division
- * const power = Int.pow(a, b);    // Int (1000)
- *
- * // Utility operations
- * const absolute = Int.abs(asInt(-42));    // Int (42)
- * const minimum = Int.min(a, b, asInt(5)); // Int (3)
- * const maximum = Int.max(a, b, asInt(5)); // Int (10)
- *
- * // Random generation
- * const die = Int.random(asInt(1), asInt(6)); // Random Int in [1, 6]
- * ```
+ * Unlike SafeInt, Int allows values outside the safe integer range (±2^53 - 1),
+ * but be aware that very large integers may lose precision in JavaScript's
+ * number type.
  */
 const Int = {
     /**
      * Type guard that checks if a value is an integer.
      *
+     * @example
+     *
+     * ```ts
+     * assert.ok(isInt(5));
+     * assert.notOk(isInt(5.25));
+     * assert.ok(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 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.
-     *
-     * @param a - The integer value
-     * @returns The absolute value as a non-negative Int
+     * 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.
      *
      * @example
-     * ```typescript
-     * Int.abs(asInt(-5));  // Int (5)
-     * Int.abs(asInt(3));   // Int (3)
-     * Int.abs(asInt(-0));  // Int (0)
+     *
+     * ```ts
+     * const negative = asInt(-12);
+     * const absolute = Int.abs(negative);
+     *
+     * assert(absolute === 12);
+     * assert.ok(Int.is(absolute));
      * ```
+     *
+     * @param a - The integer value
+     * @returns The absolute value as a non-negative Int
      */
     abs,
     /**
      * Returns the minimum value from a list of integers.
      *
-     * @param values - The integers to compare (at least one required)
-     * @returns The smallest value as an Int
-     *
      * @example
-     * ```typescript
-     * Int.min(asInt(5), asInt(3));           // Int (3)
-     * Int.min(asInt(-10), asInt(0), asInt(10)); // Int (-10)
+     *
+     * ```ts
+     * const smallest = Int.min(asInt(7), asInt(-3), asInt(2));
+     *
+     * assert(smallest === -3);
      * ```
+     *
+     * @param values - The integers to compare (at least one required)
+     * @returns The smallest value as an Int
      */
     min: min_,
     /**
      * Returns the maximum value from a list of integers.
      *
-     * @param values - The integers to compare (at least one required)
-     * @returns The largest value as an Int
-     *
      * @example
-     * ```typescript
-     * Int.max(asInt(5), asInt(3));           // Int (5)
-     * Int.max(asInt(-10), asInt(0), asInt(10)); // Int (10)
+     *
+     * ```ts
+     * const largest = Int.max(asInt(7), asInt(-3), asInt(2));
+     *
+     * assert(largest === 7);
      * ```
+     *
+     * @param values - The integers to compare (at least one required)
+     * @returns The largest value as an Int
      */
     max: max_,
     /**
      * Generates a random integer within the specified range (inclusive).
      *
-     * The range is inclusive on both ends, so random(1, 6) can return
-     * any of: 1, 2, 3, 4, 5, or 6.
-     *
-     * @param min - The minimum value (inclusive)
-     * @param max - The maximum value (inclusive)
-     * @returns A random Int in the range [min, max]
+     * The range is inclusive on both ends, so random(1, 6) can return any of: 1,
+     * 2, 3, 4, 5, or 6.
      *
      * @example
-     * ```typescript
-     * // Dice roll
-     * const d6 = Int.random(asInt(1), asInt(6));
      *
-     * // Random array index
-     * const index = Int.random(asInt(0), asInt(array.length - 1));
+     * ```ts
+     * const min = asInt(1);
+     * const max = asInt(6);
+     * const randomValue = Int.random(min, max);
      *
-     * // Can generate negative values
-     * const temp = Int.random(asInt(-10), asInt(10));
+     * assert.ok(Int.is(randomValue));
+     * assert.ok(randomValue >= 1 && randomValue <= 6);
      * ```
+     *
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random Int in the range [min, max]
      */
     random,
     /**
      * Raises an integer to a power.
+     *
+     * @example
+     *
+     * ```ts
+     * const base = asInt(2);
+     * const exponent = asInt(5);
+     * const power = Int.pow(base, exponent);
+     *
+     * assert(power === 32);
+     * ```
+     *
      * @param a - The base integer
      * @param b - The exponent integer
      * @returns `a ** b` as an Int
-     * @example
-     * ```typescript
-     * Int.pow(asInt(2), asInt(3)); // Int (8)
-     * ```
      */
     pow,
     /**
      * Adds two integers.
+     *
+     * @example
+     *
+     * ```ts
+     * const sum = Int.add(asInt(12), asInt(8));
+     *
+     * assert(sum === 20);
+     * ```
+     *
      * @param a - First integer
      * @param b - Second integer
      * @returns `a + b` as an Int
-     * @example
-     * ```typescript
-     * Int.add(asInt(5), asInt(3)); // Int (8)
-     * ```
      */
     add,
     /**
      * Subtracts two integers.
+     *
+     * @example
+     *
+     * ```ts
+     * const difference = Int.sub(asInt(12), asInt(8));
+     *
+     * assert(difference === 4);
+     * ```
+     *
      * @param a - First integer
      * @param b - Second integer
      * @returns `a - b` as an Int
-     * @example
-     * ```typescript
-     * Int.sub(asInt(8), asInt(3)); // Int (5)
-     * ```
      */
     sub,
     /**
      * Multiplies two integers.
+     *
+     * @example
+     *
+     * ```ts
+     * const product = Int.mul(asInt(-4), asInt(6));
+     *
+     * assert(product === -24);
+     * ```
+     *
      * @param a - First integer
      * @param b - Second integer
      * @returns `a * b` as an Int
-     * @example
-     * ```typescript
-     * Int.mul(asInt(4), asInt(3)); // Int (12)
-     * ```
      */
     mul,
     /**
      * Divides two integers using floor division.
      *
-     * Performs mathematical floor division: `⌊a / b⌋`.
-     * The result is always an integer, rounding toward negative infinity.
+     * Performs mathematical floor division: `⌊a / b⌋`. The result is always an
+     * integer, rounding toward negative infinity.
+     *
+     * @example
+     *
+     * ```ts
+     * const dividend = asInt(17);
+     * const divisor = asInt(5);
+     * const quotient = Int.div(dividend, divisor);
+     *
+     * assert(quotient === 3);
+     * ```
      *
      * @param a - The dividend
      * @param b - The divisor (must be non-zero)
      * @returns The integer quotient as an Int
-     *
-     * @example
-     * ```typescript
-     * // Positive division
-     * Int.div(asInt(10), asInt(3));   // Int (3)
-     * Int.div(asInt(9), asInt(3));    // Int (3)
-     *
-     * // Negative division (rounds toward -∞)
-     * Int.div(asInt(-10), asInt(3));  // Int (-4)
-     * Int.div(asInt(10), asInt(-3));  // Int (-4)
-     * Int.div(asInt(-10), asInt(-3)); // Int (3)
-     * ```
      */
     div,
 };

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

@@ -1 +1 @@
-{"version":3,"file":"int.mjs","sources":["../../../src/number/branded-types/int.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA,MAAM,iBAAiB,GAAG,YAAY;AAEtC,MAAM,EACJ,GAAG,EACH,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,MAAM,EACN,EAAE,EACF,QAAQ,GACT,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,SAAS;AAC/B,IAAA,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS;IAC5B,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;;;;;;;;;;;;;;AAmBG;AACI,MAAM,KAAK,GAAG;AAErB;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,MAAM,KAAK,GAAG;AAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCG;AACI,MAAM,GAAG,GAAG;AACjB;;;;;;;AAOG;IACH,EAAE;AAEF;;;;;;;;;;;;;;;;AAgBG;IACH,GAAG;AAEH;;;;;;;;;;;AAWG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;;;;;AAWG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;;;;;;;;;;;;;;;AAqBG;IACH,MAAM;AAEN;;;;;;;;;AASG;IACH,GAAG;AAEH;;;;;;;;;AASG;IACH,GAAG;AAEH;;;;;;;;;AASG;IACH,GAAG;AAEH;;;;;;;;;AASG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;;;;;;AAqBG;IACH,GAAG;;;;;"}
+{"version":3,"file":"int.mjs","sources":["../../../src/number/branded-types/int.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA,MAAM,iBAAiB,GAAG,YAAY;AAEtC,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;AACA,IAAA,oBAAoB,EAAE,SAAS;AAC/B,IAAA,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS;IAC5B,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;;;;;;;;;;;;AAiBG;AACI,MAAM,KAAK,GAAG;AAErB;;;;;;;;;;;;;;;;;;;AAmBG;AACI,MAAM,KAAK,GAAG;AAErB;;;;;;;;;;AAUG;AACI,MAAM,GAAG,GAAG;AACjB;;;;;;;;;;;;;;AAcG;IACH,EAAE;AAEF;;;;;;;;;;;;;;;;;;;AAmBG;IACH,GAAG;AAEH;;;;;;;;;;;;;AAaG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;;;;;;;AAaG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;;;;;;;;;;;;;;;AAoBG;IACH,MAAM;AAEN;;;;;;;;;;;;;;;;AAgBG;IACH,GAAG;AAEH;;;;;;;;;;;;;;AAcG;IACH,GAAG;AAEH;;;;;;;;;;;;;;AAcG;IACH,GAAG;AAEH;;;;;;;;;;;;;;AAcG;IACH,GAAG;AAEH;;;;;;;;;;;;;;;;;;;AAmBG;IACH,GAAG;;;;;"}

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

@@ -1,22 +1,18 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 /**
- * Checks if a number is an Int16 (16-bit signed integer in the range [-2^15, 2^15)).
+ * Checks if a number is an Int16 (16-bit signed integer in the range [-2^15,
+ * 2^15)).
+ *
  * @param value The value to check.
  * @returns `true` if the value is an Int16, `false` otherwise.
  */
 export declare const isInt16: (a: number) => a is Int16;
 /**
  * Casts a number to an Int16 type.
+ *
  * @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).
- * @example
- * ```typescript
- * const x = asInt16(1000); // Int16
- * const y = asInt16(-5000); // Int16
- * // asInt16(50000); // throws TypeError
- * // asInt16(1.5); // throws TypeError
- * ```
  */
 export declare const asInt16: <N extends number>(x: N) => number & {
     readonly NaNValue: false;
@@ -35,55 +31,43 @@ 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.
- *
- * All operations automatically clamp results to the valid Int16 range [-32768, 32767].
- * This ensures that all arithmetic maintains the 16-bit signed integer constraint.
- *
- * @example
- * ```typescript
- * const a = asInt16(30000);
- * const b = asInt16(5000);
- *
- * // Arithmetic operations with automatic clamping
- * const sum = Int16.add(a, b);      // Int16 (32767 - clamped to MAX_VALUE)
- * const diff = Int16.sub(a, b);     // Int16 (25000)
- * const product = Int16.mul(a, b);  // Int16 (32767 - clamped due to overflow)
- *
- * // Range operations
- * const clamped = Int16.clamp(100000);    // Int16 (32767)
- * const minimum = Int16.min(a, b);        // Int16 (5000)
- * const maximum = Int16.max(a, b);        // Int16 (30000)
+ * Namespace providing type-safe arithmetic operations for 16-bit signed
+ * integers.
  *
- * // Range constants
- * const range = Int16.MAX_VALUE - Int16.MIN_VALUE + 1; // 65536
- * ```
+ * All operations automatically clamp results to the valid Int16 range [-32768,
+ * 32767]. This ensures that all arithmetic maintains the 16-bit signed integer
+ * constraint.
  */
 export declare const Int16: {
     /**
      * Type guard to check if a value is an Int16.
+     *
      * @param value The value to check.
      * @returns `true` if the value is a 16-bit signed integer, `false` otherwise.
      */
     readonly is: (a: number) => a is Int16;
     /**
      * The minimum value for a 16-bit signed integer.
+     *
      * @readonly
      */
     readonly MIN_VALUE: number;
     /**
      * The maximum value for a 16-bit signed integer.
+     *
      * @readonly
      */
     readonly MAX_VALUE: number;
     /**
      * Returns the absolute value of a 16-bit signed integer.
+     *
      * @param a The Int16 value.
      * @returns The absolute value as an Int16, clamped to valid range.
      */
     readonly abs: (x: WithSmallInt<Int16, 40>) => TsDataForgeInternals.RefinedNumberUtils.ToNonNegative<Int16>;
     /**
      * Returns the smaller of two Int16 values.
+     *
      * @param a The first Int16.
      * @param b The second Int16.
      * @returns The minimum value as an Int16.
@@ -91,6 +75,7 @@ export declare const Int16: {
     readonly min: (...values: readonly WithSmallInt<Int16, 40>[]) => Int16;
     /**
      * Returns the larger of two Int16 values.
+     *
      * @param a The first Int16.
      * @param b The second Int16.
      * @returns The maximum value as an Int16.
@@ -98,17 +83,20 @@ export declare const Int16: {
     readonly max: (...values: readonly WithSmallInt<Int16, 40>[]) => Int16;
     /**
      * Clamps a number to the Int16 range.
+     *
      * @param value The number to clamp.
      * @returns The value clamped to [-32768, 32767] as an Int16.
      */
     readonly clamp: (x: number) => Int16;
     /**
      * Generates a random Int16 value within the valid range.
+     *
      * @returns A random Int16 between MIN_VALUE and MAX_VALUE.
      */
     readonly random: (min?: WithSmallInt<Int16, 40> | undefined, max?: WithSmallInt<Int16, 40> | undefined) => Int16;
     /**
      * Raises an Int16 to the power of another Int16.
+     *
      * @param a The base Int16.
      * @param b The exponent Int16.
      * @returns `a ** b` clamped to [-32768, 32767] as an Int16.
@@ -116,6 +104,7 @@ export declare const Int16: {
     readonly pow: (x: WithSmallInt<Int16, 40>, y: WithSmallInt<Int16, 40>) => Int16;
     /**
      * Adds two Int16 values.
+     *
      * @param a The first Int16.
      * @param b The second Int16.
      * @returns `a + b` clamped to [-32768, 32767] as an Int16.
@@ -123,6 +112,7 @@ export declare const Int16: {
     readonly add: (x: WithSmallInt<Int16, 40>, y: WithSmallInt<Int16, 40>) => Int16;
     /**
      * Subtracts one Int16 from another.
+     *
      * @param a The minuend Int16.
      * @param b The subtrahend Int16.
      * @returns `a - b` clamped to [-32768, 32767] as an Int16.
@@ -130,6 +120,7 @@ export declare const Int16: {
     readonly sub: (x: WithSmallInt<Int16, 40>, y: WithSmallInt<Int16, 40>) => Int16;
     /**
      * Multiplies two Int16 values.
+     *
      * @param a The first Int16.
      * @param b The second Int16.
      * @returns `a * b` clamped to [-32768, 32767] as an Int16.
@@ -137,6 +128,7 @@ export declare const Int16: {
     readonly mul: (x: WithSmallInt<Int16, 40>, y: WithSmallInt<Int16, 40>) => Int16;
     /**
      * Divides one Int16 by another using floor division.
+     *
      * @param a The dividend Int16.
      * @param b The divisor Int16.
      * @returns `⌊a / b⌋` clamped to [-32768, 32767] as an Int16.

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":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAgCnE;;;;GAIG;AACH,eAAO,MAAM,OAAO,2BAAK,CAAC;AAE1B;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,KAAK;IAChB;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int16.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAgCnE;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,2BAAK,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"}

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

@@ -1,82 +1,66 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
 const typeNameInMessage = 'an integer in [-2^15, 2^15)';
-const { MIN_VALUE, MAX_VALUE, min: min_, max: max_, abs, pow, add, sub, mul, div, random, is, castType, clamp, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+const { MAX_VALUE, MIN_VALUE, abs, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
     integerOrSafeInteger: 'SafeInteger',
     MIN_VALUE: -32768,
     MAX_VALUE: 2 ** 15 - 1,
     typeNameInMessage,
 });
 /**
- * Checks if a number is an Int16 (16-bit signed integer in the range [-2^15, 2^15)).
+ * Checks if a number is an Int16 (16-bit signed integer in the range [-2^15,
+ * 2^15)).
+ *
  * @param value The value to check.
  * @returns `true` if the value is an Int16, `false` otherwise.
  */
 const isInt16 = is;
 /**
  * Casts a number to an Int16 type.
+ *
  * @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).
- * @example
- * ```typescript
- * const x = asInt16(1000); // Int16
- * const y = asInt16(-5000); // Int16
- * // asInt16(50000); // throws TypeError
- * // asInt16(1.5); // throws TypeError
- * ```
  */
 const asInt16 = castType;
 /**
- * Namespace providing type-safe arithmetic operations for 16-bit signed integers.
- *
- * All operations automatically clamp results to the valid Int16 range [-32768, 32767].
- * This ensures that all arithmetic maintains the 16-bit signed integer constraint.
- *
- * @example
- * ```typescript
- * const a = asInt16(30000);
- * const b = asInt16(5000);
- *
- * // Arithmetic operations with automatic clamping
- * const sum = Int16.add(a, b);      // Int16 (32767 - clamped to MAX_VALUE)
- * const diff = Int16.sub(a, b);     // Int16 (25000)
- * const product = Int16.mul(a, b);  // Int16 (32767 - clamped due to overflow)
- *
- * // Range operations
- * const clamped = Int16.clamp(100000);    // Int16 (32767)
- * const minimum = Int16.min(a, b);        // Int16 (5000)
- * const maximum = Int16.max(a, b);        // Int16 (30000)
+ * Namespace providing type-safe arithmetic operations for 16-bit signed
+ * integers.
  *
- * // Range constants
- * const range = Int16.MAX_VALUE - Int16.MIN_VALUE + 1; // 65536
- * ```
+ * All operations automatically clamp results to the valid Int16 range [-32768,
+ * 32767]. This ensures that all arithmetic maintains the 16-bit signed integer
+ * constraint.
  */
 const Int16 = {
     /**
      * Type guard to check if a value is an Int16.
+     *
      * @param value The value to check.
      * @returns `true` if the value is a 16-bit signed integer, `false` otherwise.
      */
     is,
     /**
      * The minimum value for a 16-bit signed integer.
+     *
      * @readonly
      */
     MIN_VALUE,
     /**
      * The maximum value for a 16-bit signed integer.
+     *
      * @readonly
      */
     MAX_VALUE,
     /**
      * Returns the absolute value of a 16-bit signed integer.
+     *
      * @param a The Int16 value.
      * @returns The absolute value as an Int16, clamped to valid range.
      */
     abs,
     /**
      * Returns the smaller of two Int16 values.
+     *
      * @param a The first Int16.
      * @param b The second Int16.
      * @returns The minimum value as an Int16.
@@ -84,6 +68,7 @@ const Int16 = {
     min: min_,
     /**
      * Returns the larger of two Int16 values.
+     *
      * @param a The first Int16.
      * @param b The second Int16.
      * @returns The maximum value as an Int16.
@@ -91,17 +76,20 @@ const Int16 = {
     max: max_,
     /**
      * Clamps a number to the Int16 range.
+     *
      * @param value The number to clamp.
      * @returns The value clamped to [-32768, 32767] as an Int16.
      */
     clamp,
     /**
      * Generates a random Int16 value within the valid range.
+     *
      * @returns A random Int16 between MIN_VALUE and MAX_VALUE.
      */
     random,
     /**
      * Raises an Int16 to the power of another Int16.
+     *
      * @param a The base Int16.
      * @param b The exponent Int16.
      * @returns `a ** b` clamped to [-32768, 32767] as an Int16.
@@ -109,6 +97,7 @@ const Int16 = {
     pow,
     /**
      * Adds two Int16 values.
+     *
      * @param a The first Int16.
      * @param b The second Int16.
      * @returns `a + b` clamped to [-32768, 32767] as an Int16.
@@ -116,6 +105,7 @@ const Int16 = {
     add,
     /**
      * Subtracts one Int16 from another.
+     *
      * @param a The minuend Int16.
      * @param b The subtrahend Int16.
      * @returns `a - b` clamped to [-32768, 32767] as an Int16.
@@ -123,6 +113,7 @@ const Int16 = {
     sub,
     /**
      * Multiplies two Int16 values.
+     *
      * @param a The first Int16.
      * @param b The second Int16.
      * @returns `a * b` clamped to [-32768, 32767] as an Int16.
@@ -130,6 +121,7 @@ const Int16 = {
     mul,
     /**
      * Divides one Int16 by another using floor division.
+     *
      * @param a The dividend Int16.
      * @param b The divisor Int16.
      * @returns `⌊a / b⌋` clamped to [-32768, 32767] as an Int16.

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

@@ -1 +1 @@
-{"version":3,"file":"int16.mjs","sources":["../../../src/number/branded-types/int16.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA,MAAM,iBAAiB,GAAG,6BAA6B;AAEvD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,MAAM,EACN,EAAE,EACF,QAAQ,EACR,KAAK,GACN,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,SAAS,EAAE,MAAU;AACrB,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;AAIG;AACI,MAAM,OAAO,GAAG;AAEvB;;;;;;;;;;;;AAYG;AACI,MAAM,OAAO,GAAG;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;AAwBG;AACI,MAAM,KAAK,GAAG;AACnB;;;;AAIG;IACH,EAAE;AAEF;;;AAGG;IACH,SAAS;AAET;;;AAGG;IACH,SAAS;AAET;;;;AAIG;IACH,GAAG;AAEH;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;AAIG;IACH,KAAK;AAEL;;;AAGG;IACH,MAAM;AAEN;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;;;;;"}
+{"version":3,"file":"int16.mjs","sources":["../../../src/number/branded-types/int16.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA,MAAM,iBAAiB,GAAG,6BAA6B;AAEvD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,GAAG,EACH,QAAQ,EACR,KAAK,EACL,GAAG,EACH,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,SAAS,EAAE,MAAU;AACrB,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;AAMG;AACI,MAAM,OAAO,GAAG;AAEvB;;;;;;AAMG;AACI,MAAM,OAAO,GAAG;AAEvB;;;;;;;AAOG;AACI,MAAM,KAAK,GAAG;AACnB;;;;;AAKG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;AAKG;IACH,GAAG;AAEH;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;;;;;"}