ts-data-forge 11.0.0 → 11.0.1

package/dist/number/branded-types/non-negative-int32.d.mts

@@ -1,19 +1,24 @@
 import { type NonNegativeInt32 as TtfImported_NonNegativeInt32 } from 'ts-type-forge';
 export type NonNegativeInt32 = TtfImported_NonNegativeInt32;
 /**
- * Checks if a number is a NonNegativeInt32 (32-bit non-negative signed integer
- * in the range [0, 2^31)).
+ * Type guard that checks if a value is a non-negative integer in [0, 2^31).
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonNegativeInt32, `false` otherwise.
+ * Returns `true` for a non-negative integer in [0, 2^31) — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise
  */
 export declare const isNonNegativeInt32: (a: number) => a is TtfImported_NonNegativeInt32;
 /**
- * Casts a number to a NonNegativeInt32 type.
+ * Casts a `number` to the `NonNegativeInt32` branded type.
+ *
+ * Validates that the value is a non-negative integer in [0, 2^31) and returns
+ * it with the `NonNegativeInt32` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonNegativeInt32 type.
- * @throws {TypeError} If the value is not a non-negative integer in [0, 2^31).
+ * @param value - The value to cast
+ * @returns The value as a `NonNegativeInt32`
+ * @throws {TypeError} If the value is not a non-negative integer in [0, 2^31)
  */
 export declare const asNonNegativeInt32: <N extends number>(x: N) => number & {
     readonly "< 2^31": true;
@@ -31,103 +36,104 @@ export declare const asNonNegativeInt32: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 32-bit non-negative
- * integers.
+ * Namespace providing type-safe operations for the `NonNegativeInt32` branded
+ * type.
  *
- * All operations automatically clamp results to the valid NonNegativeInt32
- * range [0, 2147483647]. This ensures that all arithmetic maintains the 32-bit
- * non-negative integer constraint, with negative results clamped to 0 and
- * overflow results clamped to MAX_VALUE.
+ * The `NonNegativeInt32` type represents a non-negative integer in [0, 2^31).
+ * Division (`div`) uses floor division.
  */
 export declare const NonNegativeInt32: {
     /**
-     * Type guard to check if a value is a NonNegativeInt32.
+     * Type guard that checks if a value is a non-negative integer in [0, 2^31).
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a 32-bit non-negative integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise
+     * @see {@link isNonNegativeInt32} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonNegativeInt32;
     /**
-     * The minimum value for a 32-bit non-negative integer.
-     *
-     * @readonly
+     * The smallest value representable as `NonNegativeInt32`.
      */
     readonly MIN_VALUE: 0;
     /**
-     * The maximum value for a 32-bit non-negative integer.
-     *
-     * @readonly
+     * The largest value representable as `NonNegativeInt32`.
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the smaller of two NonNegativeInt32 values.
+     * Returns the smallest of the given non-negative integers.
      *
-     * @param a The first NonNegativeInt32.
-     * @param b The second NonNegativeInt32.
-     * @returns The minimum value as a NonNegativeInt32.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The smallest value as a `NonNegativeInt32`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>[]) => TtfImported_NonNegativeInt32;
     /**
-     * Returns the larger of two NonNegativeInt32 values.
+     * Returns the largest of the given non-negative integers.
      *
-     * @param a The first NonNegativeInt32.
-     * @param b The second NonNegativeInt32.
-     * @returns The maximum value as a NonNegativeInt32.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The largest value as a `NonNegativeInt32`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>[]) => TtfImported_NonNegativeInt32;
     /**
-     * Clamps a number to the NonNegativeInt32 range.
+     * Clamps a `number` into the `NonNegativeInt32` range, rounding to the
+     * nearest integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, 2147483647] as a NonNegativeInt32.
+     * @param value - The value to clamp
+     * @returns The clamped value as a `NonNegativeInt32`
      */
     readonly clamp: (x: number) => TtfImported_NonNegativeInt32;
     /**
-     * Generates a random NonNegativeInt32 value within the valid range.
+     * Generates a random `NonNegativeInt32` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random NonNegativeInt32 between 0 and 2147483647.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonNegativeInt32` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32> | undefined) => TtfImported_NonNegativeInt32;
     /**
-     * Raises a NonNegativeInt32 to the power of another NonNegativeInt32.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt32`
+     * (floored to an integer).
      *
-     * @param a The base NonNegativeInt32.
-     * @param b The exponent NonNegativeInt32.
-     * @returns `a ** b` clamped to [0, 2147483647] as a NonNegativeInt32.
+     * @param a - The base non-negative integer
+     * @param b - The exponent non-negative integer
+     * @returns `a ** b` as a `NonNegativeInt32`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>) => TtfImported_NonNegativeInt32;
     /**
-     * Adds two NonNegativeInt32 values.
+     * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt32`.
      *
-     * @param a The first NonNegativeInt32.
-     * @param b The second NonNegativeInt32.
-     * @returns `a + b` clamped to [0, 2147483647] as a NonNegativeInt32.
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The sum of `a` and `b` as a `NonNegativeInt32`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>) => TtfImported_NonNegativeInt32;
     /**
-     * Subtracts one NonNegativeInt32 from another.
+     * Subtracts two non-negative integers, returning `a - b` as a
+     * `NonNegativeInt32`.
      *
-     * @param a The minuend NonNegativeInt32.
-     * @param b The subtrahend NonNegativeInt32.
-     * @returns `a - b` clamped to [0, 2147483647] as a NonNegativeInt32 (minimum
-     *   0).
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The difference of `a` and `b` as a `NonNegativeInt32`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>) => TtfImported_NonNegativeInt32;
     /**
-     * Multiplies two NonNegativeInt32 values.
+     * Multiplies two non-negative integers, returning `a * b` as a
+     * `NonNegativeInt32`.
      *
-     * @param a The first NonNegativeInt32.
-     * @param b The second NonNegativeInt32.
-     * @returns `a * b` clamped to [0, 2147483647] as a NonNegativeInt32.
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The product of `a` and `b` as a `NonNegativeInt32`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>) => TtfImported_NonNegativeInt32;
     /**
-     * Divides one NonNegativeInt32 by another using floor division.
+     * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+     * result is `a / b` rounded toward negative infinity, as a
+     * `NonNegativeInt32`.
      *
-     * @param a The dividend NonNegativeInt32.
-     * @param b The divisor NonNegativeInt32.
-     * @returns `⌊a / b⌋` clamped to [0, 2147483647] as a NonNegativeInt32.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as a `NonNegativeInt32`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt32>, 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/non-negative-int32.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"non-negative-int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-int32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,IAAI,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAItF,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AA+B5D;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,kDAAK,CAAC;AAErC;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;MAAW,CAAC;AAE3C;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"non-negative-int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-int32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,IAAI,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAItF,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AA+B5D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,kDAAK,CAAC;AAErC;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;MAAW,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;OAQG;;;;;;;;;;;;;;;;;CAEK,CAAC"}

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

@@ -25,93 +25,96 @@ const isNonNegativeInt32 = is;
 const asNonNegativeInt32 = castType;
 const NonNegativeInt32 = {
   /**
-   * Type guard to check if a value is a NonNegativeInt32.
+   * Type guard that checks if a value is a non-negative integer in [0, 2^31).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 32-bit non-negative integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise
+   * @see {@link isNonNegativeInt32} for usage examples
    */
   is,
   /**
-   * The minimum value for a 32-bit non-negative integer.
-   *
-   * @readonly
+   * The smallest value representable as `NonNegativeInt32`.
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 32-bit non-negative integer.
-   *
-   * @readonly
+   * The largest value representable as `NonNegativeInt32`.
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two NonNegativeInt32 values.
+   * Returns the smallest of the given non-negative integers.
    *
-   * @param a The first NonNegativeInt32.
-   * @param b The second NonNegativeInt32.
-   * @returns The minimum value as a NonNegativeInt32.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The smallest value as a `NonNegativeInt32`
    */
   min: min_,
   /**
-   * Returns the larger of two NonNegativeInt32 values.
+   * Returns the largest of the given non-negative integers.
    *
-   * @param a The first NonNegativeInt32.
-   * @param b The second NonNegativeInt32.
-   * @returns The maximum value as a NonNegativeInt32.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The largest value as a `NonNegativeInt32`
    */
   max: max_,
   /**
-   * Clamps a number to the NonNegativeInt32 range.
+   * Clamps a `number` into the `NonNegativeInt32` range, rounding to the
+   * nearest integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, 2147483647] as a NonNegativeInt32.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonNegativeInt32`
    */
   clamp,
   /**
-   * Generates a random NonNegativeInt32 value within the valid range.
+   * Generates a random `NonNegativeInt32` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random NonNegativeInt32 between 0 and 2147483647.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonNegativeInt32` in `[min, max]`
    */
   random,
   /**
-   * Raises a NonNegativeInt32 to the power of another NonNegativeInt32.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt32`
+   * (floored to an integer).
    *
-   * @param a The base NonNegativeInt32.
-   * @param b The exponent NonNegativeInt32.
-   * @returns `a ** b` clamped to [0, 2147483647] as a NonNegativeInt32.
+   * @param a - The base non-negative integer
+   * @param b - The exponent non-negative integer
+   * @returns `a ** b` as a `NonNegativeInt32`
    */
   pow,
   /**
-   * Adds two NonNegativeInt32 values.
+   * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt32`.
    *
-   * @param a The first NonNegativeInt32.
-   * @param b The second NonNegativeInt32.
-   * @returns `a + b` clamped to [0, 2147483647] as a NonNegativeInt32.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The sum of `a` and `b` as a `NonNegativeInt32`
    */
   add,
   /**
-   * Subtracts one NonNegativeInt32 from another.
+   * Subtracts two non-negative integers, returning `a - b` as a
+   * `NonNegativeInt32`.
    *
-   * @param a The minuend NonNegativeInt32.
-   * @param b The subtrahend NonNegativeInt32.
-   * @returns `a - b` clamped to [0, 2147483647] as a NonNegativeInt32 (minimum
-   *   0).
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The difference of `a` and `b` as a `NonNegativeInt32`
    */
   sub,
   /**
-   * Multiplies two NonNegativeInt32 values.
+   * Multiplies two non-negative integers, returning `a * b` as a
+   * `NonNegativeInt32`.
    *
-   * @param a The first NonNegativeInt32.
-   * @param b The second NonNegativeInt32.
-   * @returns `a * b` clamped to [0, 2147483647] as a NonNegativeInt32.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The product of `a` and `b` as a `NonNegativeInt32`
    */
   mul,
   /**
-   * Divides one NonNegativeInt32 by another using floor division.
+   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as a
+   * `NonNegativeInt32`.
    *
-   * @param a The dividend NonNegativeInt32.
-   * @param b The divisor NonNegativeInt32.
-   * @returns `⌊a / b⌋` clamped to [0, 2147483647] as a NonNegativeInt32.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `NonNegativeInt32`
    */
   div
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-negative-int32.mjs","sources":["../../../src/number/branded-types/non-negative-int32.mts"],"sourcesContent":["import { type NonNegativeInt32 as TtfImported_NonNegativeInt32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeInt32 = TtfImported_NonNegativeInt32;\n\ntype ElementType = NonNegativeInt32;\n\nconst typeNameInMessage = 'a non-negative integer in [0, 2^31)';\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  0,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  MAX_VALUE: 2 ** 31 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a NonNegativeInt32 (32-bit non-negative signed integer\n * in the range [0, 2^31)).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonNegativeInt32, `false` otherwise.\n */\nexport const isNonNegativeInt32 = is;\n\n/**\n * Casts a number to a NonNegativeInt32 type.\n *\n * @param value The value to cast.\n * @returns The value as a NonNegativeInt32 type.\n * @throws {TypeError} If the value is not a non-negative integer in [0, 2^31).\n */\nexport const asNonNegativeInt32 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 32-bit non-negative\n * integers.\n *\n * All operations automatically clamp results to the valid NonNegativeInt32\n * range [0, 2147483647]. This ensures that all arithmetic maintains the 32-bit\n * non-negative integer constraint, with negative results clamped to 0 and\n * overflow results clamped to MAX_VALUE.\n */\nexport const NonNegativeInt32 = {\n  /**\n   * Type guard to check if a value is a NonNegativeInt32.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a 32-bit non-negative integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a 32-bit non-negative integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a 32-bit non-negative integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two NonNegativeInt32 values.\n   *\n   * @param a The first NonNegativeInt32.\n   * @param b The second NonNegativeInt32.\n   * @returns The minimum value as a NonNegativeInt32.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonNegativeInt32 values.\n   *\n   * @param a The first NonNegativeInt32.\n   * @param b The second NonNegativeInt32.\n   * @returns The maximum value as a NonNegativeInt32.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the NonNegativeInt32 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [0, 2147483647] as a NonNegativeInt32.\n   */\n  clamp,\n\n  /**\n   * Generates a random NonNegativeInt32 value within the valid range.\n   *\n   * @returns A random NonNegativeInt32 between 0 and 2147483647.\n   */\n  random,\n\n  /**\n   * Raises a NonNegativeInt32 to the power of another NonNegativeInt32.\n   *\n   * @param a The base NonNegativeInt32.\n   * @param b The exponent NonNegativeInt32.\n   * @returns `a ** b` clamped to [0, 2147483647] as a NonNegativeInt32.\n   */\n  pow,\n\n  /**\n   * Adds two NonNegativeInt32 values.\n   *\n   * @param a The first NonNegativeInt32.\n   * @param b The second NonNegativeInt32.\n   * @returns `a + b` clamped to [0, 2147483647] as a NonNegativeInt32.\n   */\n  add,\n\n  /**\n   * Subtracts one NonNegativeInt32 from another.\n   *\n   * @param a The minuend NonNegativeInt32.\n   * @param b The subtrahend NonNegativeInt32.\n   * @returns `a - b` clamped to [0, 2147483647] as a NonNegativeInt32 (minimum\n   *   0).\n   */\n  sub,\n\n  /**\n   * Multiplies two NonNegativeInt32 values.\n   *\n   * @param a The first NonNegativeInt32.\n   * @param b The second NonNegativeInt32.\n   * @returns `a * b` clamped to [0, 2147483647] as a NonNegativeInt32.\n   */\n  mul,\n\n  /**\n   * Divides one NonNegativeInt32 by another using floor division.\n   *\n   * @param a The dividend NonNegativeInt32.\n   * @param b The divisor NonNegativeInt32.\n   * @returns `⌊a / b⌋` clamped to [0, 2147483647] as a NonNegativeInt32.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeInt32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeInt32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,qCAAA;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,kBAAA,GAAqB;AAS3B,MAAM,kBAAA,GAAqB;AAW3B,MAAM,gBAAA,GAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9B,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;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}
+{"version":3,"file":"non-negative-int32.mjs","sources":["../../../src/number/branded-types/non-negative-int32.mts"],"sourcesContent":["import { type NonNegativeInt32 as TtfImported_NonNegativeInt32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeInt32 = TtfImported_NonNegativeInt32;\n\ntype ElementType = NonNegativeInt32;\n\nconst typeNameInMessage = 'a non-negative integer in [0, 2^31)';\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  0,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  MAX_VALUE: 2 ** 31 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative integer in [0, 2^31).\n *\n * Returns `true` for a non-negative integer in [0, 2^31) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise\n */\nexport const isNonNegativeInt32 = is;\n\n/**\n * Casts a `number` to the `NonNegativeInt32` branded type.\n *\n * Validates that the value is a non-negative integer in [0, 2^31) and returns\n * it with the `NonNegativeInt32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeInt32`\n * @throws {TypeError} If the value is not a non-negative integer in [0, 2^31)\n */\nexport const asNonNegativeInt32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeInt32` branded\n * type.\n *\n * The `NonNegativeInt32` type represents a non-negative integer in [0, 2^31).\n * Division (`div`) uses floor division.\n */\nexport const NonNegativeInt32 = {\n  /**\n   * Type guard that checks if a value is a non-negative integer in [0, 2^31).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative integer in [0, 2^31), `false` otherwise\n   * @see {@link isNonNegativeInt32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeInt32`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonNegativeInt32`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeInt32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative integers.\n   *\n   * @param values - The non-negative integers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeInt32`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonNegativeInt32` range, rounding to the\n   * nearest integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NonNegativeInt32`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NonNegativeInt32` 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 `NonNegativeInt32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt32`\n   * (floored to an integer).\n   *\n   * @param a - The base non-negative integer\n   * @param b - The exponent non-negative integer\n   * @returns `a ** b` as a `NonNegativeInt32`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The sum of `a` and `b` as a `NonNegativeInt32`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative integers, returning `a - b` as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The difference of `a` and `b` as a `NonNegativeInt32`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative integers, returning `a * b` as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The first non-negative integer\n   * @param b - The second non-negative integer\n   * @returns The product of `a` and `b` as a `NonNegativeInt32`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the\n   * result is `a / b` rounded toward negative infinity, as a\n   * `NonNegativeInt32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `NonNegativeInt32`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeInt32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeInt32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,qCAAA;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;AAWH,MAAM,kBAAA,GAAqB;AAY3B,MAAM,kBAAA,GAAqB;AAS3B,MAAM,gBAAA,GAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9B,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,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,EASL,KAAA;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;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA;AACF;;;;"}

package/dist/number/branded-types/non-positive-finite-number.d.mts

@@ -3,18 +3,24 @@ import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 export type NonPositiveFiniteNumber = TtfImported_NonPositiveFiniteNumber;
 type ElementType = NonPositiveFiniteNumber;
 /**
- * Checks if a number is a NonPositiveFiniteNumber (a finite number <= 0).
+ * Type guard that checks if a value is a non-positive finite number.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonPositiveFiniteNumber, `false` otherwise.
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-positive finite number, `false` otherwise
  */
 export declare const isNonPositiveFiniteNumber: (a: number) => a is TtfImported_NonPositiveFiniteNumber;
 /**
- * Casts a number to a NonPositiveFiniteNumber type.
+ * Casts a `number` to the `NonPositiveFiniteNumber` branded type.
+ *
+ * Validates that the value is a non-positive finite number and returns it with
+ * the `NonPositiveFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonPositiveFiniteNumber type.
- * @throws {TypeError} If the value is not a non-positive finite number.
+ * @param value - The value to cast
+ * @returns The value as a `NonPositiveFiniteNumber`
+ * @throws {TypeError} If the value is not a non-positive finite number
  */
 export declare const asNonPositiveFiniteNumber: <N extends number>(x: N) => number & {
     readonly "< 2^15": true;
@@ -28,101 +34,105 @@ export declare const asNonPositiveFiniteNumber: <N extends number>(x: N) => numb
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for non-positive finite
- * numbers.
+ * Namespace providing type-safe operations for the `NonPositiveFiniteNumber`
+ * branded type.
  *
- * All operations maintain the non-positive constraint by clamping positive
- * results to MAX_VALUE (0), while ensuring results remain finite (excluding NaN
- * and Infinity). This type is useful for representing quantities that must
- * always be non-positive, such as debts, penalties, and negative offsets.
+ * The `NonPositiveFiniteNumber` type represents a non-positive finite number.
  */
 export declare const NonPositiveFiniteNumber: {
     /**
-     * Type guard to check if a value is a NonPositiveFiniteNumber.
+     * Type guard that checks if a value is a non-positive finite number.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-positive finite number, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-positive finite number, `false` otherwise
+     * @see {@link isNonPositiveFiniteNumber} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonPositiveFiniteNumber;
     /**
-     * The maximum value for a non-positive finite number.
-     *
-     * @readonly
+     * The largest value representable as `NonPositiveFiniteNumber`.
      */
     readonly MAX_VALUE: 0;
     /**
-     * Returns the smaller of two NonPositiveFiniteNumber values.
+     * Returns the smallest of the given non-positive finite numbers.
      *
-     * @param a The first NonPositiveFiniteNumber.
-     * @param b The second NonPositiveFiniteNumber.
-     * @returns The minimum value as a NonPositiveFiniteNumber.
+     * @param values - The non-positive finite numbers to compare (at least one required)
+     * @returns The smallest value as a `NonPositiveFiniteNumber`
      */
     readonly min: (...values: readonly TtfImported_NonPositiveFiniteNumber[]) => TtfImported_NonPositiveFiniteNumber;
     /**
-     * Returns the larger of two NonPositiveFiniteNumber values.
+     * Returns the largest of the given non-positive finite numbers.
      *
-     * @param a The first NonPositiveFiniteNumber.
-     * @param b The second NonPositiveFiniteNumber.
-     * @returns The maximum value as a NonPositiveFiniteNumber.
+     * @param values - The non-positive finite numbers to compare (at least one required)
+     * @returns The largest value as a `NonPositiveFiniteNumber`
      */
     readonly max: (...values: readonly TtfImported_NonPositiveFiniteNumber[]) => TtfImported_NonPositiveFiniteNumber;
     /**
-     * Clamps a number to the non-positive finite range.
+     * Clamps a `number` into the `NonPositiveFiniteNumber` range `[MIN_VALUE,
+     * MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     * @param value - The value to clamp
+     * @returns The clamped value as a `NonPositiveFiniteNumber`
      */
     readonly clamp: (x: number) => TtfImported_NonPositiveFiniteNumber;
     /**
-     * Rounds down a NonPositiveFiniteNumber to the nearest integer.
+     * Returns the greatest integer less than or equal to a non-positive finite
+     * number.
      *
-     * @param x The NonPositiveFiniteNumber to round down.
-     * @returns The floor value as a NonPositiveInt (can be 0).
+     * @param a - The non-positive finite number value
+     * @returns The floored value as an integer
      */
     readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * Rounds up a NonPositiveFiniteNumber to the nearest integer.
+     * Returns the smallest integer greater than or equal to a non-positive finite
+     * number.
      *
-     * @param x The NonPositiveFiniteNumber to round up.
-     * @returns The ceiling value as a NegativeInt (always <= -1) or 0.
+     * @param a - The non-positive finite number value
+     * @returns The ceiled value as an integer
      */
     readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * Rounds a NonPositiveFiniteNumber to the nearest integer.
+     * Returns the value of a non-positive finite number rounded to the nearest
+     * integer.
      *
-     * @param x The NonPositiveFiniteNumber to round.
-     * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
+     * @param a - The non-positive finite number value
+     * @returns The rounded value as an integer
      */
     readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * Generates a random NonPositiveFiniteNumber value.
+     * Generates a random `NonPositiveFiniteNumber` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random non-positive finite number.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonPositiveFiniteNumber` in `[min, max]`
      */
     readonly random: (min?: TtfImported_NonPositiveFiniteNumber | undefined, max?: TtfImported_NonPositiveFiniteNumber | undefined) => TtfImported_NonPositiveFiniteNumber;
     /**
-     * Raises a NonPositiveFiniteNumber to the power of another NonPositiveFiniteNumber.
+     * Raises `a` to the power `b`, returning `a ** b` as a
+     * `NonPositiveFiniteNumber`.
      *
-     * @param a The base NonPositiveFiniteNumber.
-     * @param b The exponent NonPositiveFiniteNumber.
-     * @returns `a ** b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     * @param a - The base non-positive finite number
+     * @param b - The exponent non-positive finite number
+     * @returns `a ** b` as a `NonPositiveFiniteNumber`
      */
     readonly pow: (x: TtfImported_NonPositiveFiniteNumber, y: TtfImported_NonPositiveFiniteNumber) => TtfImported_NonPositiveFiniteNumber;
     /**
-     * Adds two NonPositiveFiniteNumber values.
+     * Adds two non-positive finite numbers, returning `a + b` as a
+     * `NonPositiveFiniteNumber`.
      *
-     * @param a The first NonPositiveFiniteNumber.
-     * @param b The second NonPositiveFiniteNumber.
-     * @returns `a + b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+     * @param a - The first non-positive finite number
+     * @param b - The second non-positive finite number
+     * @returns The sum of `a` and `b` as a `NonPositiveFiniteNumber`
      */
     readonly add: (x: TtfImported_NonPositiveFiniteNumber, y: TtfImported_NonPositiveFiniteNumber) => TtfImported_NonPositiveFiniteNumber;
     /**
-     * Subtracts one NonPositiveFiniteNumber from another.
+     * Subtracts two non-positive finite numbers, returning `a - b` as a
+     * `NonPositiveFiniteNumber`.
      *
-     * @param a The minuend NonPositiveFiniteNumber.
-     * @param b The subtrahend NonPositiveFiniteNumber.
-     * @returns `a - b` clamped to (-∞, 0] as a NonPositiveFiniteNumber (maximum 0).
+     * @param a - The first non-positive finite number
+     * @param b - The second non-positive finite number
+     * @returns The difference of `a` and `b` as a `NonPositiveFiniteNumber`
      */
     readonly sub: (x: TtfImported_NonPositiveFiniteNumber, y: TtfImported_NonPositiveFiniteNumber) => TtfImported_NonPositiveFiniteNumber;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,uBAAuB,IAAI,mCAAmC,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AA2D3C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;wBA3GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA2GC;;;;;OAKG;uBAvGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAuGC;;;;;OAKG;wBArGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAqGC;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}
+{"version":3,"file":"non-positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,uBAAuB,IAAI,mCAAmC,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AA2D3C;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;wBA5GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IA4GC;;;;;;OAMG;uBAzGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAyGC;;;;;;OAMG;wBAxGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAwGC;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}