ts-data-forge 11.0.0 → 12.0.0

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"positive-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA+BtD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,+CAAK,CAAC;AAElC;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA+BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,+CAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;;;CAEK,CAAC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"positive-int16.mjs","sources":["../../../src/number/branded-types/positive-int16.mts"],"sourcesContent":["import { type PositiveInt16 as TtfImported_PositiveInt16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveInt16 = TtfImported_PositiveInt16;\n\ntype ElementType = PositiveInt16;\n\nconst typeNameInMessage = 'a positive integer in [1, 2^15)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\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  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 1,\n  MAX_VALUE: 2 ** 15 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a PositiveInt16 (16-bit positive signed integer in the\n * range [1, 2^15)).\n *\n * @param value The value to check.\n * @returns `true` if the value is a PositiveInt16, `false` otherwise.\n */\nexport const isPositiveInt16 = is;\n\n/**\n * Casts a number to a PositiveInt16 type.\n *\n * @param value The value to cast.\n * @returns The value as a PositiveInt16 type.\n * @throws {TypeError} If the value is not a positive integer in [1, 2^15).\n */\nexport const asPositiveInt16 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 16-bit positive\n * integers.\n *\n * All operations automatically clamp results to the valid PositiveInt16 range\n * [1, 32767]. This ensures that all arithmetic maintains the 16-bit positive\n * integer constraint, with results below 1 clamped to MIN_VALUE and overflow\n * results clamped to MAX_VALUE.\n */\nexport const PositiveInt16 = {\n  /**\n   * Type guard to check if a value is a PositiveInt16.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a 16-bit positive integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a 16-bit positive integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a 16-bit positive integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two PositiveInt16 values.\n   *\n   * @param a The first PositiveInt16.\n   * @param b The second PositiveInt16.\n   * @returns The minimum value as a PositiveInt16.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two PositiveInt16 values.\n   *\n   * @param a The first PositiveInt16.\n   * @param b The second PositiveInt16.\n   * @returns The maximum value as a PositiveInt16.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the PositiveInt16 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [1, 32767] as a PositiveInt16.\n   */\n  clamp,\n\n  /**\n   * Generates a random PositiveInt16 value within the valid range.\n   *\n   * @returns A random PositiveInt16 between 1 and 32767.\n   */\n  random,\n\n  /**\n   * Raises a PositiveInt16 to the power of another PositiveInt16.\n   *\n   * @param a The base PositiveInt16.\n   * @param b The exponent PositiveInt16.\n   * @returns `a ** b` clamped to [1, 32767] as a PositiveInt16.\n   */\n  pow,\n\n  /**\n   * Adds two PositiveInt16 values.\n   *\n   * @param a The first PositiveInt16.\n   * @param b The second PositiveInt16.\n   * @returns `a + b` clamped to [1, 32767] as a PositiveInt16.\n   */\n  add,\n\n  /**\n   * Subtracts one PositiveInt16 from another.\n   *\n   * @param a The minuend PositiveInt16.\n   * @param b The subtrahend PositiveInt16.\n   * @returns `a - b` clamped to [1, 32767] as a PositiveInt16 (minimum 1).\n   */\n  sub,\n\n  /**\n   * Multiplies two PositiveInt16 values.\n   *\n   * @param a The first PositiveInt16.\n   * @param b The second PositiveInt16.\n   * @returns `a * b` clamped to [1, 32767] as a PositiveInt16.\n   */\n  mul,\n\n  /**\n   * Divides one PositiveInt16 by another using floor division.\n   *\n   * @param a The dividend PositiveInt16.\n   * @param b The divisor PositiveInt16.\n   * @returns `⌊a / b⌋` clamped to [1, 32767] as a PositiveInt16.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveInt16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveInt16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,iCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;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,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AASH,MAAM,eAAA,GAAkB;AASxB,MAAM,eAAA,GAAkB;AAWxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,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":"positive-int16.mjs","sources":["../../../src/number/branded-types/positive-int16.mts"],"sourcesContent":["import { type PositiveInt16 as TtfImported_PositiveInt16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveInt16 = TtfImported_PositiveInt16;\n\ntype ElementType = PositiveInt16;\n\nconst typeNameInMessage = 'a positive integer in [1, 2^15)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\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  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 1,\n  MAX_VALUE: 2 ** 15 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive integer in [1, 2^15).\n *\n * Returns `true` for a positive integer in [1, 2^15) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive integer in [1, 2^15), `false` otherwise\n */\nexport const isPositiveInt16 = is;\n\n/**\n * Casts a `number` to the `PositiveInt16` branded type.\n *\n * Validates that the value is a positive integer in [1, 2^15) and returns it\n * with the `PositiveInt16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveInt16`\n * @throws {TypeError} If the value is not a positive integer in [1, 2^15)\n */\nexport const asPositiveInt16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveInt16` branded\n * type.\n *\n * The `PositiveInt16` type represents a positive integer in [1, 2^15). Division\n * (`div`) uses floor division.\n */\nexport const PositiveInt16 = {\n  /**\n   * Type guard that checks if a value is a positive integer in [1, 2^15).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive integer in [1, 2^15), `false` otherwise\n   * @see {@link isPositiveInt16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveInt16` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `PositiveInt16` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The smallest value as a `PositiveInt16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive integers.\n   *\n   * @param values - The positive integers to compare (at least one required)\n   * @returns The largest value as a `PositiveInt16`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `PositiveInt16`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asPositiveInt16`, this is total: out-of-range inputs are clamped to\n   * the nearest representable `PositiveInt16` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `PositiveInt16`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `PositiveInt16` 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 `PositiveInt16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt16`\n   * (floored to an integer).\n   *\n   * @param a - The base positive integer\n   * @param b - The exponent positive integer\n   * @returns `a ** b` as a `PositiveInt16`\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, returning `a + b` as a `PositiveInt16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The sum of `a` and `b` as a `PositiveInt16`\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, returning `a - b` as a `PositiveInt16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The difference of `a` and `b` as a `PositiveInt16`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, returning `a * b` as a `PositiveInt16`.\n   *\n   * @param a - The first positive integer\n   * @param b - The second positive integer\n   * @returns The product of `a` and `b` as a `PositiveInt16`\n   */\n  mul,\n\n  /**\n   * Divides two positive integers using floor division (`⌊a / b⌋`): the result\n   * is `a / b` rounded toward negative infinity, as a `PositiveInt16`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `PositiveInt16`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveInt16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveInt16,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,iCAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;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,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,eAAA,GAAkB;AAYxB,MAAM,eAAA,GAAkB;AASxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;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;AAAA,EAaL,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;;;;"}

package/dist/number/branded-types/positive-int32.d.mts

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

package/dist/number/branded-types/positive-int32.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"positive-int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA+BtD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,+CAAK,CAAC;AAElC;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA+BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,+CAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;;;;CAEK,CAAC"}