ts-data-forge 11.0.0 → 11.0.1

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

@@ -25,93 +25,93 @@ const isPositiveUint32 = is;
 const asPositiveUint32 = castType;
 const PositiveUint32 = {
   /**
-   * Type guard to check if a value is a PositiveUint32.
+   * Type guard that checks if a value is a positive integer in [1, 2^32).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 32-bit positive unsigned integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a positive integer in [1, 2^32), `false` otherwise
+   * @see {@link isPositiveUint32} for usage examples
    */
   is,
   /**
-   * The minimum value for a 32-bit positive unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveUint32`.
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 32-bit positive unsigned integer.
-   *
-   * @readonly
+   * The largest value representable as `PositiveUint32`.
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two PositiveUint32 values.
+   * Returns the smallest of the given positive integers.
    *
-   * @param a The first PositiveUint32.
-   * @param b The second PositiveUint32.
-   * @returns The minimum value as a PositiveUint32.
+   * @param values - The positive integers to compare (at least one required)
+   * @returns The smallest value as a `PositiveUint32`
    */
   min: min_,
   /**
-   * Returns the larger of two PositiveUint32 values.
+   * Returns the largest of the given positive integers.
    *
-   * @param a The first PositiveUint32.
-   * @param b The second PositiveUint32.
-   * @returns The maximum value as a PositiveUint32.
+   * @param values - The positive integers to compare (at least one required)
+   * @returns The largest value as a `PositiveUint32`
    */
   max: max_,
   /**
-   * Clamps a number to the PositiveUint32 range.
+   * Clamps a `number` into the `PositiveUint32` 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 [1, 4294967295] as a PositiveUint32.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `PositiveUint32`
    */
   clamp,
   /**
-   * Generates a random PositiveUint32 value within the valid range.
+   * Generates a random `PositiveUint32` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random PositiveUint32 between 1 and 4294967295.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveUint32` in `[min, max]`
    */
   random,
   /**
-   * Raises a PositiveUint32 to the power of another PositiveUint32.
+   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveUint32`
+   * (floored to an integer).
    *
-   * @param a The base PositiveUint32.
-   * @param b The exponent PositiveUint32.
-   * @returns `a ** b` clamped to [1, 4294967295] as a PositiveUint32.
+   * @param a - The base positive integer
+   * @param b - The exponent positive integer
+   * @returns `a ** b` as a `PositiveUint32`
    */
   pow,
   /**
-   * Adds two PositiveUint32 values.
+   * Adds two positive integers, returning `a + b` as a `PositiveUint32`.
    *
-   * @param a The first PositiveUint32.
-   * @param b The second PositiveUint32.
-   * @returns `a + b` clamped to [1, 4294967295] as a PositiveUint32.
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The sum of `a` and `b` as a `PositiveUint32`
    */
   add,
   /**
-   * Subtracts one PositiveUint32 from another.
+   * Subtracts two positive integers, returning `a - b` as a `PositiveUint32`.
    *
-   * @param a The minuend PositiveUint32.
-   * @param b The subtrahend PositiveUint32.
-   * @returns `a - b` clamped to [1, 4294967295] as a PositiveUint32 (minimum
-   *   1).
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The difference of `a` and `b` as a `PositiveUint32`
    */
   sub,
   /**
-   * Multiplies two PositiveUint32 values.
+   * Multiplies two positive integers, returning `a * b` as a `PositiveUint32`.
    *
-   * @param a The first PositiveUint32.
-   * @param b The second PositiveUint32.
-   * @returns `a * b` clamped to [1, 4294967295] as a PositiveUint32.
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The product of `a` and `b` as a `PositiveUint32`
    */
   mul,
   /**
-   * Divides one PositiveUint32 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 `PositiveUint32`.
    *
-   * @param a The dividend PositiveUint32.
-   * @param b The divisor PositiveUint32.
-   * @returns `⌊a / b⌋` clamped to [1, 4294967295] as a PositiveUint32.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `PositiveUint32`
    */
   div
 };

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

@@ -1 +1 @@
-{"version":3,"file":"positive-uint32.mjs","sources":["../../../src/number/branded-types/positive-uint32.mts"],"sourcesContent":["import { type PositiveUint32 as TtfImported_PositiveUint32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveUint32 = TtfImported_PositiveUint32;\n\ntype ElementType = PositiveUint32;\n\nconst typeNameInMessage = 'a positive integer in [1, 2^32)';\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 ** 32 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a PositiveUint32 (32-bit positive unsigned integer in\n * the range [1, 2^32)).\n *\n * @param value The value to check.\n * @returns `true` if the value is a PositiveUint32, `false` otherwise.\n */\nexport const isPositiveUint32 = is;\n\n/**\n * Casts a number to a PositiveUint32 type.\n *\n * @param value The value to cast.\n * @returns The value as a PositiveUint32 type.\n * @throws {TypeError} If the value is not a positive integer in [1, 2^32).\n */\nexport const asPositiveUint32 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 32-bit positive\n * unsigned integers.\n *\n * All operations automatically clamp results to the valid PositiveUint32 range\n * [1, 4294967295]. This ensures that all arithmetic maintains the 32-bit\n * positive unsigned integer constraint, with results below 1 clamped to\n * MIN_VALUE and overflow results clamped to MAX_VALUE.\n */\nexport const PositiveUint32 = {\n  /**\n   * Type guard to check if a value is a PositiveUint32.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a 32-bit positive unsigned integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a 32-bit positive unsigned integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a 32-bit positive unsigned integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two PositiveUint32 values.\n   *\n   * @param a The first PositiveUint32.\n   * @param b The second PositiveUint32.\n   * @returns The minimum value as a PositiveUint32.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two PositiveUint32 values.\n   *\n   * @param a The first PositiveUint32.\n   * @param b The second PositiveUint32.\n   * @returns The maximum value as a PositiveUint32.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the PositiveUint32 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [1, 4294967295] as a PositiveUint32.\n   */\n  clamp,\n\n  /**\n   * Generates a random PositiveUint32 value within the valid range.\n   *\n   * @returns A random PositiveUint32 between 1 and 4294967295.\n   */\n  random,\n\n  /**\n   * Raises a PositiveUint32 to the power of another PositiveUint32.\n   *\n   * @param a The base PositiveUint32.\n   * @param b The exponent PositiveUint32.\n   * @returns `a ** b` clamped to [1, 4294967295] as a PositiveUint32.\n   */\n  pow,\n\n  /**\n   * Adds two PositiveUint32 values.\n   *\n   * @param a The first PositiveUint32.\n   * @param b The second PositiveUint32.\n   * @returns `a + b` clamped to [1, 4294967295] as a PositiveUint32.\n   */\n  add,\n\n  /**\n   * Subtracts one PositiveUint32 from another.\n   *\n   * @param a The minuend PositiveUint32.\n   * @param b The subtrahend PositiveUint32.\n   * @returns `a - b` clamped to [1, 4294967295] as a PositiveUint32 (minimum\n   *   1).\n   */\n  sub,\n\n  /**\n   * Multiplies two PositiveUint32 values.\n   *\n   * @param a The first PositiveUint32.\n   * @param b The second PositiveUint32.\n   * @returns `a * b` clamped to [1, 4294967295] as a PositiveUint32.\n   */\n  mul,\n\n  /**\n   * Divides one PositiveUint32 by another using floor division.\n   *\n   * @param a The dividend PositiveUint32.\n   * @param b The divisor PositiveUint32.\n   * @returns `⌊a / b⌋` clamped to [1, 4294967295] as a PositiveUint32.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveUint32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveUint32,\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,gBAAA,GAAmB;AASzB,MAAM,gBAAA,GAAmB;AAWzB,MAAM,cAAA,GAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5B,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":"positive-uint32.mjs","sources":["../../../src/number/branded-types/positive-uint32.mts"],"sourcesContent":["import { type PositiveUint32 as TtfImported_PositiveUint32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveUint32 = TtfImported_PositiveUint32;\n\ntype ElementType = PositiveUint32;\n\nconst typeNameInMessage = 'a positive integer in [1, 2^32)';\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 ** 32 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a positive integer in [1, 2^32).\n *\n * Returns `true` for a positive integer in [1, 2^32) — 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^32), `false` otherwise\n */\nexport const isPositiveUint32 = is;\n\n/**\n * Casts a `number` to the `PositiveUint32` branded type.\n *\n * Validates that the value is a positive integer in [1, 2^32) and returns it\n * with the `PositiveUint32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveUint32`\n * @throws {TypeError} If the value is not a positive integer in [1, 2^32)\n */\nexport const asPositiveUint32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveUint32` branded\n * type.\n *\n * The `PositiveUint32` type represents a positive integer in [1, 2^32).\n * Division (`div`) uses floor division.\n */\nexport const PositiveUint32 = {\n  /**\n   * Type guard that checks if a value is a positive integer in [1, 2^32).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive integer in [1, 2^32), `false` otherwise\n   * @see {@link isPositiveUint32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveUint32`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `PositiveUint32`.\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 `PositiveUint32`\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 `PositiveUint32`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `PositiveUint32` range, rounding to the nearest\n   * 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 `PositiveUint32`\n   */\n  clamp,\n\n  /**\n   * Generates a random `PositiveUint32` 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 `PositiveUint32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveUint32`\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 `PositiveUint32`\n   */\n  pow,\n\n  /**\n   * Adds two positive integers, returning `a + b` as a `PositiveUint32`.\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 `PositiveUint32`\n   */\n  add,\n\n  /**\n   * Subtracts two positive integers, returning `a - b` as a `PositiveUint32`.\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 `PositiveUint32`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive integers, returning `a * b` as a `PositiveUint32`.\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 `PositiveUint32`\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 `PositiveUint32`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `PositiveUint32`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveUint32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveUint32,\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;AAWH,MAAM,gBAAA,GAAmB;AAYzB,MAAM,gBAAA,GAAmB;AASzB,MAAM,cAAA,GAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5B,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,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/safe-int.d.mts

@@ -3,8 +3,7 @@ export type SafeInt = TtfImported_SafeInt;
 /**
  * Type guard that checks if a value is a safe integer.
  *
- * A safe integer is an integer that can be exactly represented in JavaScript
- * without precision loss. The range is [±(2^53 - 1)].
+ * Returns `true` for a safe integer — a value with no fractional component.
  *
  * @example
  *
@@ -21,11 +20,10 @@ export type SafeInt = TtfImported_SafeInt;
  */
 export declare const isSafeInt: (a: number) => a is TtfImported_SafeInt;
 /**
- * Casts a number to a SafeInt branded type.
+ * Casts a `number` to the `SafeInt` branded type.
  *
- * This function validates that the input is a safe integer (within ±(2^53 - 1))
- * and returns it with the SafeInt brand. This ensures type safety for
- * operations that require precise integer arithmetic.
+ * Validates that the value is a safe integer and returns it with the `SafeInt`
+ * brand. Throws a `TypeError` otherwise.
  *
  * @example
  *
@@ -38,7 +36,7 @@ export declare const isSafeInt: (a: number) => a is TtfImported_SafeInt;
  * ```
  *
  * @param value - The value to cast
- * @returns The value as a SafeInt branded type
+ * @returns The value as a `SafeInt`
  * @throws {TypeError} If the value is not a safe integer
  */
 export declare const asSafeInt: <N extends number>(x: N) => number & {
@@ -50,20 +48,10 @@ export declare const asSafeInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe operations for SafeInt branded types.
+ * Namespace providing type-safe operations for the `SafeInt` branded type.
  *
- * SafeInt represents integers that can be exactly represented in JavaScript's
- * number type without precision loss. The range is [±(2^53 - 1)], which covers
- * approximately ±9 quadrillion.
- *
- * All operations automatically clamp results to stay within the safe range,
- * preventing precision loss that occurs with larger integers. This makes
- * SafeInt ideal for:
- *
- * - Financial calculations requiring exact cents
- * - Database IDs and counters
- * - Array indices and sizes
- * - Any integer arithmetic requiring precision guarantees
+ * The `SafeInt` type represents a safe integer. Division (`div`) uses floor
+ * division.
  */
 export declare const SafeInt: {
     /**
@@ -85,22 +73,17 @@ export declare const SafeInt: {
      */
     readonly is: (a: number) => a is TtfImported_SafeInt;
     /**
-     * The minimum safe integer value (-(2^53 - 1)).
-     *
-     * @readonly
+     * The smallest value representable as `SafeInt`.
      */
     readonly MIN_VALUE: TtfImported_SafeInt;
     /**
-     * The maximum safe integer value (2^53 - 1).
-     *
-     * @readonly
+     * The largest value representable as `SafeInt`.
      */
     readonly MAX_VALUE: SafeUint;
     /**
      * Returns the absolute value of a safe integer.
      *
-     * Note: `Math.abs(MIN_SAFE_INTEGER)` would exceed `MAX_SAFE_INTEGER`, so this
-     * function clamps the result to maintain the safe integer guarantee.
+     * The result is non-negative and keeps the `SafeInt` brand.
      *
      * @example
      *
@@ -115,11 +98,11 @@ export declare const SafeInt: {
      * ```
      *
      * @param a - The safe integer value
-     * @returns The absolute value as a SafeInt, clamped if necessary
+     * @returns The absolute value as a non-negative `SafeInt`
      */
     readonly abs: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>) => import("ts-type-forge").IntersectBrand<TtfImported_SafeInt, import("ts-type-forge").NonNegativeNumber>;
     /**
-     * Returns the minimum value from a list of safe integers.
+     * Returns the smallest of the given safe integers.
      *
      * @example
      *
@@ -130,11 +113,11 @@ export declare const SafeInt: {
      * ```
      *
      * @param values - The safe integers to compare (at least one required)
-     * @returns The smallest value as a SafeInt
+     * @returns The smallest value as a `SafeInt`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>[]) => TtfImported_SafeInt;
     /**
-     * Returns the maximum value from a list of safe integers.
+     * Returns the largest of the given safe integers.
      *
      * @example
      *
@@ -145,11 +128,12 @@ export declare const SafeInt: {
      * ```
      *
      * @param values - The safe integers to compare (at least one required)
-     * @returns The largest value as a SafeInt
+     * @returns The largest value as a `SafeInt`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>[]) => TtfImported_SafeInt;
     /**
-     * Clamps a number to the safe integer range.
+     * Clamps a `number` into the `SafeInt` range, rounding to the nearest integer
+     * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
      * @example
      *
@@ -167,16 +151,14 @@ export declare const SafeInt: {
      * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);
      * ```
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] as a
-     *   SafeInt.
+     * @param value - The value to clamp
+     * @returns The clamped value as a `SafeInt`
      */
     readonly clamp: (x: number) => TtfImported_SafeInt;
     /**
-     * Generates a random safe integer within the specified range (inclusive).
+     * Generates a random `SafeInt` within the given range.
      *
-     * The range is inclusive on both ends. If min > max, they are automatically
-     * swapped.
+     * The range is inclusive on both ends.
      *
      * @example
      *
@@ -194,11 +176,12 @@ export declare const SafeInt: {
      *
      * @param min - The minimum value (inclusive)
      * @param max - The maximum value (inclusive)
-     * @returns A random SafeInt in the range [min, max]
+     * @returns A random `SafeInt` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt> | undefined) => TtfImported_SafeInt;
     /**
-     * Raises a SafeInt to the power of another SafeInt.
+     * Raises `a` to the power `b`, returning `a ** b` as a `SafeInt` (floored to
+     * an integer).
      *
      * @example
      *
@@ -214,13 +197,13 @@ export declare const SafeInt: {
      * assert.isTrue(SafeInt.is(power));
      * ```
      *
-     * @param a The base SafeInt.
-     * @param b The exponent SafeInt.
-     * @returns `a ** b` clamped to safe integer range as a SafeInt.
+     * @param a - The base safe integer
+     * @param b - The exponent safe integer
+     * @returns `a ** b` as a `SafeInt`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>) => TtfImported_SafeInt;
     /**
-     * Adds two SafeInt values.
+     * Adds two safe integers, returning `a + b` as a `SafeInt`.
      *
      * @example
      *
@@ -232,13 +215,13 @@ export declare const SafeInt: {
      * assert.isTrue(SafeInt.is(sum));
      * ```
      *
-     * @param a The first SafeInt.
-     * @param b The second SafeInt.
-     * @returns `a + b` clamped to safe integer range as a SafeInt.
+     * @param a - The first safe integer
+     * @param b - The second safe integer
+     * @returns The sum of `a` and `b` as a `SafeInt`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>) => TtfImported_SafeInt;
     /**
-     * Subtracts one SafeInt from another.
+     * Subtracts two safe integers, returning `a - b` as a `SafeInt`.
      *
      * @example
      *
@@ -250,13 +233,13 @@ export declare const SafeInt: {
      * assert.isTrue(SafeInt.is(difference));
      * ```
      *
-     * @param a The minuend SafeInt.
-     * @param b The subtrahend SafeInt.
-     * @returns `a - b` clamped to safe integer range as a SafeInt.
+     * @param a - The first safe integer
+     * @param b - The second safe integer
+     * @returns The difference of `a` and `b` as a `SafeInt`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>) => TtfImported_SafeInt;
     /**
-     * Multiplies two SafeInt values.
+     * Multiplies two safe integers, returning `a * b` as a `SafeInt`.
      *
      * @example
      *
@@ -268,16 +251,14 @@ export declare const SafeInt: {
      * assert.isTrue(SafeInt.is(product));
      * ```
      *
-     * @param a The first SafeInt.
-     * @param b The second SafeInt.
-     * @returns `a * b` clamped to safe integer range as a SafeInt.
+     * @param a - The first safe integer
+     * @param b - The second safe integer
+     * @returns The product of `a` and `b` as a `SafeInt`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>) => TtfImported_SafeInt;
     /**
-     * Divides one SafeInt by another using floor division.
-     *
-     * Performs mathematical floor division: `⌊a / b⌋`. The divisor must be
-     * non-zero (enforced by type constraints).
+     * Divides two safe integers using floor division (`⌊a / b⌋`): the result is
+     * `a / b` rounded toward negative infinity, as a `SafeInt`.
      *
      * @example
      *
@@ -291,7 +272,7 @@ export declare const SafeInt: {
      *
      * @param a - The dividend
      * @param b - The divisor (must be non-zero)
-     * @returns The integer quotient as a SafeInt
+     * @returns The floored quotient as a `SafeInt`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeInt>, y: -40 | -39 | -38 | -37 | -36 | -35 | -34 | -33 | -32 | -31 | -30 | -29 | -28 | -27 | -26 | -25 | -24 | -23 | -22 | -21 | -20 | -19 | -18 | -17 | -16 | -15 | -14 | -13 | -12 | -11 | -10 | -9 | -8 | -7 | -6 | -5 | -4 | -3 | -2 | -1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
         readonly "!=0": true;

package/dist/number/branded-types/safe-int.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,OAAO,IAAI,mBAAmB,EACpC,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAkC1C;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,SAAS,yCAAK,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,SAAS;;;;;;;MAAW,CAAC;AAElC;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO;IAClB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;OAuBG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,OAAO,IAAI,mBAAmB,EACpC,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAkC1C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,yCAAK,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS;;;;;;;MAAW,CAAC;AAElC;;;;;GAKG;AACH,eAAO,MAAM,OAAO;IAClB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;OAqBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;;;;;;;;;CAEK,CAAC"}

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

@@ -46,22 +46,17 @@ const SafeInt = {
    */
   is,
   /**
-   * The minimum safe integer value (-(2^53 - 1)).
-   *
-   * @readonly
+   * The smallest value representable as `SafeInt`.
    */
   MIN_VALUE,
   /**
-   * The maximum safe integer value (2^53 - 1).
-   *
-   * @readonly
+   * The largest value representable as `SafeInt`.
    */
   MAX_VALUE,
   /**
    * Returns the absolute value of a safe integer.
    *
-   * Note: `Math.abs(MIN_SAFE_INTEGER)` would exceed `MAX_SAFE_INTEGER`, so this
-   * function clamps the result to maintain the safe integer guarantee.
+   * The result is non-negative and keeps the `SafeInt` brand.
    *
    * @example
    *
@@ -76,11 +71,11 @@ const SafeInt = {
    * ```
    *
    * @param a - The safe integer value
-   * @returns The absolute value as a SafeInt, clamped if necessary
+   * @returns The absolute value as a non-negative `SafeInt`
    */
   abs,
   /**
-   * Returns the minimum value from a list of safe integers.
+   * Returns the smallest of the given safe integers.
    *
    * @example
    *
@@ -91,11 +86,11 @@ const SafeInt = {
    * ```
    *
    * @param values - The safe integers to compare (at least one required)
-   * @returns The smallest value as a SafeInt
+   * @returns The smallest value as a `SafeInt`
    */
   min: min_,
   /**
-   * Returns the maximum value from a list of safe integers.
+   * Returns the largest of the given safe integers.
    *
    * @example
    *
@@ -106,11 +101,12 @@ const SafeInt = {
    * ```
    *
    * @param values - The safe integers to compare (at least one required)
-   * @returns The largest value as a SafeInt
+   * @returns The largest value as a `SafeInt`
    */
   max: max_,
   /**
-   * Clamps a number to the safe integer range.
+   * Clamps a `number` into the `SafeInt` range, rounding to the nearest integer
+   * and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
    * @example
    *
@@ -128,16 +124,14 @@ const SafeInt = {
    * assert.isTrue(belowRange === Number.MIN_SAFE_INTEGER);
    * ```
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] as a
-   *   SafeInt.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `SafeInt`
    */
   clamp,
   /**
-   * Generates a random safe integer within the specified range (inclusive).
+   * Generates a random `SafeInt` within the given range.
    *
-   * The range is inclusive on both ends. If min > max, they are automatically
-   * swapped.
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -155,11 +149,12 @@ const SafeInt = {
    *
    * @param min - The minimum value (inclusive)
    * @param max - The maximum value (inclusive)
-   * @returns A random SafeInt in the range [min, max]
+   * @returns A random `SafeInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a SafeInt to the power of another SafeInt.
+   * Raises `a` to the power `b`, returning `a ** b` as a `SafeInt` (floored to
+   * an integer).
    *
    * @example
    *
@@ -175,13 +170,13 @@ const SafeInt = {
    * assert.isTrue(SafeInt.is(power));
    * ```
    *
-   * @param a The base SafeInt.
-   * @param b The exponent SafeInt.
-   * @returns `a ** b` clamped to safe integer range as a SafeInt.
+   * @param a - The base safe integer
+   * @param b - The exponent safe integer
+   * @returns `a ** b` as a `SafeInt`
    */
   pow,
   /**
-   * Adds two SafeInt values.
+   * Adds two safe integers, returning `a + b` as a `SafeInt`.
    *
    * @example
    *
@@ -193,13 +188,13 @@ const SafeInt = {
    * assert.isTrue(SafeInt.is(sum));
    * ```
    *
-   * @param a The first SafeInt.
-   * @param b The second SafeInt.
-   * @returns `a + b` clamped to safe integer range as a SafeInt.
+   * @param a - The first safe integer
+   * @param b - The second safe integer
+   * @returns The sum of `a` and `b` as a `SafeInt`
    */
   add,
   /**
-   * Subtracts one SafeInt from another.
+   * Subtracts two safe integers, returning `a - b` as a `SafeInt`.
    *
    * @example
    *
@@ -211,13 +206,13 @@ const SafeInt = {
    * assert.isTrue(SafeInt.is(difference));
    * ```
    *
-   * @param a The minuend SafeInt.
-   * @param b The subtrahend SafeInt.
-   * @returns `a - b` clamped to safe integer range as a SafeInt.
+   * @param a - The first safe integer
+   * @param b - The second safe integer
+   * @returns The difference of `a` and `b` as a `SafeInt`
    */
   sub,
   /**
-   * Multiplies two SafeInt values.
+   * Multiplies two safe integers, returning `a * b` as a `SafeInt`.
    *
    * @example
    *
@@ -229,16 +224,14 @@ const SafeInt = {
    * assert.isTrue(SafeInt.is(product));
    * ```
    *
-   * @param a The first SafeInt.
-   * @param b The second SafeInt.
-   * @returns `a * b` clamped to safe integer range as a SafeInt.
+   * @param a - The first safe integer
+   * @param b - The second safe integer
+   * @returns The product of `a` and `b` as a `SafeInt`
    */
   mul,
   /**
-   * Divides one SafeInt by another using floor division.
-   *
-   * Performs mathematical floor division: `⌊a / b⌋`. The divisor must be
-   * non-zero (enforced by type constraints).
+   * Divides two safe integers using floor division (`⌊a / b⌋`): the result is
+   * `a / b` rounded toward negative infinity, as a `SafeInt`.
    *
    * @example
    *
@@ -252,7 +245,7 @@ const SafeInt = {
    *
    * @param a - The dividend
    * @param b - The divisor (must be non-zero)
-   * @returns The integer quotient as a SafeInt
+   * @returns The floored quotient as a `SafeInt`
    */
   div
 };