ts-data-forge 10.0.0 → 11.0.1

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

@@ -25,92 +25,93 @@ const isPositiveInt32 = is;
 const asPositiveInt32 = castType;
 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
    */
   is,
   /**
-   * The minimum value for a 32-bit positive integer.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveInt32`.
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 32-bit positive integer.
-   *
-   * @readonly
+   * The largest value representable as `PositiveInt32`.
    */
   MAX_VALUE,
   /**
-   * 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`
    */
   min: min_,
   /**
-   * 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`
    */
   max: max_,
   /**
-   * Clamps a number to the PositiveInt32 range.
+   * Clamps a `number` into the `PositiveInt32` 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, 2147483647] as a PositiveInt32.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `PositiveInt32`
    */
   clamp,
   /**
-   * 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]`
    */
   random,
   /**
-   * 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`
    */
   pow,
   /**
-   * 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`
    */
   add,
   /**
-   * 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`
    */
   sub,
   /**
-   * 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`
    */
   mul,
   /**
-   * 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`
    */
   div
 };

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

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

@@ -1,8 +1,10 @@
 import { type SafeUint, type PositiveSafeInt as TtfImported_PositiveSafeInt } from 'ts-type-forge';
 export type PositiveSafeInt = TtfImported_PositiveSafeInt;
 /**
- * Checks if a number is a PositiveSafeInt (a positive safe integer in the range
- * [1, MAX_SAFE_INTEGER]).
+ * Type guard that checks if a value is a positive safe integer.
+ *
+ * Returns `true` for a positive safe integer — a value with no fractional
+ * component.
  *
  * @example
  *
@@ -16,12 +18,15 @@ export type PositiveSafeInt = TtfImported_PositiveSafeInt;
  * assert.isTrue(PositiveSafeInt.is(42));
  * ```
  *
- * @param value The value to check.
- * @returns `true` if the value is a PositiveSafeInt, `false` otherwise.
+ * @param value - The value to check
+ * @returns `true` if the value is a positive safe integer, `false` otherwise
  */
 export declare const isPositiveSafeInt: (a: number) => a is TtfImported_PositiveSafeInt;
 /**
- * Casts a number to a PositiveSafeInt type.
+ * Casts a `number` to the `PositiveSafeInt` branded type.
+ *
+ * Validates that the value is a positive safe integer and returns it with the
+ * `PositiveSafeInt` brand. Throws a `TypeError` otherwise.
  *
  * @example
  *
@@ -33,9 +38,9 @@ export declare const isPositiveSafeInt: (a: number) => a is TtfImported_Positive
  * assert.isTrue(PositiveSafeInt.is(branded));
  * ```
  *
- * @param value The value to cast.
- * @returns The value as a PositiveSafeInt type.
- * @throws {TypeError} If the value is not a positive safe integer.
+ * @param value - The value to cast
+ * @returns The value as a `PositiveSafeInt`
+ * @throws {TypeError} If the value is not a positive safe integer
  */
 export declare const asPositiveSafeInt: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -53,17 +58,15 @@ export declare const asPositiveSafeInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for positive safe
- * integers.
+ * Namespace providing type-safe operations for the `PositiveSafeInt` branded
+ * type.
  *
- * All operations automatically clamp results to the positive safe integer range
- * [1, MAX_SAFE_INTEGER]. This ensures that all arithmetic maintains both the
- * positive constraint and IEEE 754 precision guarantees, preventing precision
- * loss and ensuring results are always positive.
+ * The `PositiveSafeInt` type represents a positive safe integer. Division
+ * (`div`) uses floor division.
  */
 export declare const PositiveSafeInt: {
     /**
-     * Type guard to check if a value is a PositiveSafeInt.
+     * Type guard that checks if a value is a positive safe integer.
      *
      * @example
      *
@@ -77,25 +80,21 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(PositiveSafeInt.is(42));
      * ```
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a positive safe integer, `false` otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a positive safe integer, `false` otherwise
      * @see {@link isPositiveSafeInt} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_PositiveSafeInt;
     /**
-     * The minimum value for a positive safe integer.
-     *
-     * @readonly
+     * The smallest value representable as `PositiveSafeInt`.
      */
     readonly MIN_VALUE: 1;
     /**
-     * The maximum safe integer value (2^53 - 1).
-     *
-     * @readonly
+     * The largest value representable as `PositiveSafeInt`.
      */
     readonly MAX_VALUE: SafeUint;
     /**
-     * Returns the smaller of two PositiveSafeInt values.
+     * Returns the smallest of the given positive safe integers.
      *
      * @example
      *
@@ -108,13 +107,12 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(smallest === 5);
      * ```
      *
-     * @param a The first PositiveSafeInt.
-     * @param b The second PositiveSafeInt.
-     * @returns The minimum value as a PositiveSafeInt.
+     * @param values - The positive safe integers to compare (at least one required)
+     * @returns The smallest value as a `PositiveSafeInt`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>[]) => TtfImported_PositiveSafeInt;
     /**
-     * Returns the larger of two PositiveSafeInt values.
+     * Returns the largest of the given positive safe integers.
      *
      * @example
      *
@@ -127,13 +125,13 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(largest === 10);
      * ```
      *
-     * @param a The first PositiveSafeInt.
-     * @param b The second PositiveSafeInt.
-     * @returns The maximum value as a PositiveSafeInt.
+     * @param values - The positive safe integers to compare (at least one required)
+     * @returns The largest value as a `PositiveSafeInt`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>[]) => TtfImported_PositiveSafeInt;
     /**
-     * Clamps a number to the positive safe integer range.
+     * Clamps a `number` into the `PositiveSafeInt` range, rounding to the nearest
+     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
      * @example
      *
@@ -151,12 +149,14 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
      * ```
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+     * @param value - The value to clamp
+     * @returns The clamped value as a `PositiveSafeInt`
      */
     readonly clamp: (x: number) => TtfImported_PositiveSafeInt;
     /**
-     * Generates a random PositiveSafeInt value within the valid range.
+     * Generates a random `PositiveSafeInt` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
      * @example
      *
@@ -172,11 +172,14 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(randomValue >= 1 && randomValue <= 6);
      * ```
      *
-     * @returns A random PositiveSafeInt between 1 and MAX_SAFE_INTEGER.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `PositiveSafeInt` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt> | undefined) => TtfImported_PositiveSafeInt;
     /**
-     * Raises a PositiveSafeInt to the power of another PositiveSafeInt.
+     * Raises `a` to the power `b`, returning `a ** b` as a `PositiveSafeInt`
+     * (floored to an integer).
      *
      * @example
      *
@@ -190,13 +193,13 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(power === 27);
      * ```
      *
-     * @param a The base PositiveSafeInt.
-     * @param b The exponent PositiveSafeInt.
-     * @returns `a ** b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+     * @param a - The base positive safe integer
+     * @param b - The exponent positive safe integer
+     * @returns `a ** b` as a `PositiveSafeInt`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>) => TtfImported_PositiveSafeInt;
     /**
-     * Adds two PositiveSafeInt values.
+     * Adds two positive safe integers, returning `a + b` as a `PositiveSafeInt`.
      *
      * @example
      *
@@ -211,13 +214,14 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(PositiveSafeInt.is(sum));
      * ```
      *
-     * @param a The first PositiveSafeInt.
-     * @param b The second PositiveSafeInt.
-     * @returns `a + b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+     * @param a - The first positive safe integer
+     * @param b - The second positive safe integer
+     * @returns The sum of `a` and `b` as a `PositiveSafeInt`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>) => TtfImported_PositiveSafeInt;
     /**
-     * Subtracts one PositiveSafeInt from another.
+     * Subtracts two positive safe integers, returning `a - b` as a
+     * `PositiveSafeInt`.
      *
      * @example
      *
@@ -232,14 +236,14 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(PositiveSafeInt.is(difference));
      * ```
      *
-     * @param a The minuend PositiveSafeInt.
-     * @param b The subtrahend PositiveSafeInt.
-     * @returns `a - b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt
-     *   (minimum 1).
+     * @param a - The first positive safe integer
+     * @param b - The second positive safe integer
+     * @returns The difference of `a` and `b` as a `PositiveSafeInt`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>) => TtfImported_PositiveSafeInt;
     /**
-     * Multiplies two PositiveSafeInt values.
+     * Multiplies two positive safe integers, returning `a * b` as a
+     * `PositiveSafeInt`.
      *
      * @example
      *
@@ -254,13 +258,14 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(PositiveSafeInt.is(product));
      * ```
      *
-     * @param a The first PositiveSafeInt.
-     * @param b The second PositiveSafeInt.
-     * @returns `a * b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+     * @param a - The first positive safe integer
+     * @param b - The second positive safe integer
+     * @returns The product of `a` and `b` as a `PositiveSafeInt`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>) => TtfImported_PositiveSafeInt;
     /**
-     * Divides one PositiveSafeInt by another using floor division.
+     * Divides two positive safe integers using floor division (`⌊a / b⌋`): the
+     * result is `a / b` rounded toward negative infinity, as a `PositiveSafeInt`.
      *
      * @example
      *
@@ -280,9 +285,9 @@ export declare const PositiveSafeInt: {
      * assert.isTrue(clamped === 1);
      * ```
      *
-     * @param a The dividend PositiveSafeInt.
-     * @param b The divisor PositiveSafeInt.
-     * @returns `⌊a / b⌋` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as a `PositiveSafeInt`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveSafeInt>, 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-safe-int.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"positive-safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,eAAe,IAAI,2BAA2B,EACpD,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,eAAe,GAAG,2BAA2B,CAAC;AAgC1D;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,iBAAiB,iDAAK,CAAC;AAEpC;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;MAAW,CAAC;AAE1C;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe;IAC1B;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;;;;OAqBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,eAAe,IAAI,2BAA2B,EACpD,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,eAAe,GAAG,2BAA2B,CAAC;AAgC1D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,iBAAiB,iDAAK,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;MAAW,CAAC;AAE1C;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;IAC1B;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;;;;;;;;;;;;;;;;CAEK,CAAC"}

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

@@ -26,7 +26,7 @@ const isPositiveSafeInt = is;
 const asPositiveSafeInt = castType;
 const PositiveSafeInt = {
   /**
-   * Type guard to check if a value is a PositiveSafeInt.
+   * Type guard that checks if a value is a positive safe integer.
    *
    * @example
    *
@@ -40,25 +40,21 @@ const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(42));
    * ```
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a positive safe integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a positive safe integer, `false` otherwise
    * @see {@link isPositiveSafeInt} for usage examples
    */
   is,
   /**
-   * The minimum value for a positive safe integer.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveSafeInt`.
    */
   MIN_VALUE,
   /**
-   * The maximum safe integer value (2^53 - 1).
-   *
-   * @readonly
+   * The largest value representable as `PositiveSafeInt`.
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two PositiveSafeInt values.
+   * Returns the smallest of the given positive safe integers.
    *
    * @example
    *
@@ -71,13 +67,12 @@ const PositiveSafeInt = {
    * assert.isTrue(smallest === 5);
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns The minimum value as a PositiveSafeInt.
+   * @param values - The positive safe integers to compare (at least one required)
+   * @returns The smallest value as a `PositiveSafeInt`
    */
   min: min_,
   /**
-   * Returns the larger of two PositiveSafeInt values.
+   * Returns the largest of the given positive safe integers.
    *
    * @example
    *
@@ -90,13 +85,13 @@ const PositiveSafeInt = {
    * assert.isTrue(largest === 10);
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns The maximum value as a PositiveSafeInt.
+   * @param values - The positive safe integers to compare (at least one required)
+   * @returns The largest value as a `PositiveSafeInt`
    */
   max: max_,
   /**
-   * Clamps a number to the positive safe integer range.
+   * Clamps a `number` into the `PositiveSafeInt` range, rounding to the nearest
+   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
    * @example
    *
@@ -114,12 +109,14 @@ const PositiveSafeInt = {
    * assert.isTrue(aboveRange === Number.MAX_SAFE_INTEGER);
    * ```
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `PositiveSafeInt`
    */
   clamp,
   /**
-   * Generates a random PositiveSafeInt value within the valid range.
+   * Generates a random `PositiveSafeInt` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -135,11 +132,14 @@ const PositiveSafeInt = {
    * assert.isTrue(randomValue >= 1 && randomValue <= 6);
    * ```
    *
-   * @returns A random PositiveSafeInt between 1 and MAX_SAFE_INTEGER.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveSafeInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a PositiveSafeInt to the power of another PositiveSafeInt.
+   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveSafeInt`
+   * (floored to an integer).
    *
    * @example
    *
@@ -153,13 +153,13 @@ const PositiveSafeInt = {
    * assert.isTrue(power === 27);
    * ```
    *
-   * @param a The base PositiveSafeInt.
-   * @param b The exponent PositiveSafeInt.
-   * @returns `a ** b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The base positive safe integer
+   * @param b - The exponent positive safe integer
+   * @returns `a ** b` as a `PositiveSafeInt`
    */
   pow,
   /**
-   * Adds two PositiveSafeInt values.
+   * Adds two positive safe integers, returning `a + b` as a `PositiveSafeInt`.
    *
    * @example
    *
@@ -174,13 +174,14 @@ const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(sum));
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns `a + b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The sum of `a` and `b` as a `PositiveSafeInt`
    */
   add,
   /**
-   * Subtracts one PositiveSafeInt from another.
+   * Subtracts two positive safe integers, returning `a - b` as a
+   * `PositiveSafeInt`.
    *
    * @example
    *
@@ -195,14 +196,14 @@ const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(difference));
    * ```
    *
-   * @param a The minuend PositiveSafeInt.
-   * @param b The subtrahend PositiveSafeInt.
-   * @returns `a - b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt
-   *   (minimum 1).
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The difference of `a` and `b` as a `PositiveSafeInt`
    */
   sub,
   /**
-   * Multiplies two PositiveSafeInt values.
+   * Multiplies two positive safe integers, returning `a * b` as a
+   * `PositiveSafeInt`.
    *
    * @example
    *
@@ -217,13 +218,14 @@ const PositiveSafeInt = {
    * assert.isTrue(PositiveSafeInt.is(product));
    * ```
    *
-   * @param a The first PositiveSafeInt.
-   * @param b The second PositiveSafeInt.
-   * @returns `a * b` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The first positive safe integer
+   * @param b - The second positive safe integer
+   * @returns The product of `a` and `b` as a `PositiveSafeInt`
    */
   mul,
   /**
-   * Divides one PositiveSafeInt by another using floor division.
+   * Divides two positive safe integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as a `PositiveSafeInt`.
    *
    * @example
    *
@@ -243,9 +245,9 @@ const PositiveSafeInt = {
    * assert.isTrue(clamped === 1);
    * ```
    *
-   * @param a The dividend PositiveSafeInt.
-   * @param b The divisor PositiveSafeInt.
-   * @returns `⌊a / b⌋` clamped to [1, MAX_SAFE_INTEGER] as a PositiveSafeInt.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `PositiveSafeInt`
    */
   div
 };