ts-data-forge 11.0.0 → 11.0.1

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

@@ -39,108 +39,116 @@ const isPositiveFiniteNumber = is;
 const asPositiveFiniteNumber = castType;
 const PositiveFiniteNumber = {
   /**
-   * Type guard to check if a value is a PositiveFiniteNumber.
+   * Type guard that checks if a value is a positive finite number.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a positive finite number, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a positive finite number, `false` otherwise
+   * @see {@link isPositiveFiniteNumber} for usage examples
    */
   is,
   /**
-   * The minimum value for a positive finite number.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveFiniteNumber`.
    */
   MIN_VALUE,
   /**
-   * Returns the smaller of two PositiveFiniteNumber values.
+   * Returns the smallest of the given positive finite numbers.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns The minimum value as a PositiveFiniteNumber.
+   * @param values - The positive finite numbers to compare (at least one required)
+   * @returns The smallest value as a `PositiveFiniteNumber`
    */
   min: min_,
   /**
-   * Returns the larger of two PositiveFiniteNumber values.
+   * Returns the largest of the given positive finite numbers.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns The maximum value as a PositiveFiniteNumber.
+   * @param values - The positive finite numbers to compare (at least one required)
+   * @returns The largest value as a `PositiveFiniteNumber`
    */
   max: max_,
   /**
-   * Clamps a number to the positive finite range.
+   * Clamps a `number` into the `PositiveFiniteNumber` range `[MIN_VALUE,
+   * MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `PositiveFiniteNumber`
    */
   clamp,
   /**
-   * Rounds down a PositiveFiniteNumber to the nearest integer.
+   * Returns the greatest integer less than or equal to a positive finite
+   * number.
    *
-   * @param x The PositiveFiniteNumber to round down.
-   * @returns The floor value as a Uint (can be 0).
+   * @param a - The positive finite number value
+   * @returns The floored value as an integer
    */
   floor,
   /**
-   * Rounds up a PositiveFiniteNumber to the nearest integer.
+   * Returns the smallest integer greater than or equal to a positive finite
+   * number.
    *
-   * @param x The PositiveFiniteNumber to round up.
-   * @returns The ceiling value as a PositiveInt (always >= 1).
+   * @param a - The positive finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
   /**
-   * Rounds a PositiveFiniteNumber to the nearest integer.
+   * Returns the value of a positive finite number rounded to the nearest
+   * integer.
    *
-   * @param x The PositiveFiniteNumber to round.
-   * @returns The rounded value as a Uint (can be 0 if x < 0.5).
+   * @param a - The positive finite number value
+   * @returns The rounded value as an integer
    */
   round,
   /**
-   * Generates a random PositiveFiniteNumber value.
+   * Generates a random `PositiveFiniteNumber` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random positive finite number.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveFiniteNumber` in `[min, max]`
    */
   random,
   /**
-   * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.
+   * Raises `a` to the power `b`, returning `a ** b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The base PositiveFiniteNumber.
-   * @param b The exponent PositiveFiniteNumber.
-   * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The base positive finite number
+   * @param b - The exponent positive finite number
+   * @returns `a ** b` as a `PositiveFiniteNumber`
    */
   pow,
   /**
-   * Adds two PositiveFiniteNumber values.
+   * Adds two positive finite numbers, returning `a + b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`
    */
   add,
   /**
-   * Subtracts one PositiveFiniteNumber from another.
+   * Subtracts two positive finite numbers, returning `a - b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The minuend PositiveFiniteNumber.
-   * @param b The subtrahend PositiveFiniteNumber.
-   * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum
-   *   MIN_VALUE).
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`
    */
   sub,
   /**
-   * Multiplies two PositiveFiniteNumber values.
+   * Multiplies two positive finite numbers, returning `a * b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The first PositiveFiniteNumber.
-   * @param b The second PositiveFiniteNumber.
-   * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The first positive finite number
+   * @param b - The second positive finite number
+   * @returns The product of `a` and `b` as a `PositiveFiniteNumber`
    */
   mul,
   /**
-   * Divides one PositiveFiniteNumber by another.
+   * Divides two positive finite numbers, returning `a / b` as a
+   * `PositiveFiniteNumber`.
    *
-   * @param a The dividend PositiveFiniteNumber.
-   * @param b The divisor PositiveFiniteNumber.
-   * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns `a / b` as a `PositiveFiniteNumber`
    */
   div
 };

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

@@ -1 +1 @@
-{"version":3,"file":"positive-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":["import {\n  type PositiveInt,\n  type PositiveFiniteNumber as TtfImported_PositiveFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;\n\ntype ElementType = PositiveFiniteNumber;\n\nconst typeNameInMessage = 'a positive finite number';\n\nconst {\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.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  MIN_VALUE: Number.MIN_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  PositiveInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Uint\n>('=');\n\n/**\n * Checks if a number is a PositiveFiniteNumber (a finite number > 0).\n *\n * @param value The value to check.\n * @returns `true` if the value is a PositiveFiniteNumber, `false` otherwise.\n */\nexport const isPositiveFiniteNumber = is;\n\n/**\n * Casts a number to a PositiveFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a PositiveFiniteNumber type.\n * @throws {TypeError} If the value is not a positive finite number.\n */\nexport const asPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for positive finite\n * numbers.\n *\n * All operations maintain the positive constraint by clamping non-positive\n * results to MIN_VALUE, while ensuring results remain finite (excluding NaN and\n * Infinity). This type is useful for representing quantities that must always\n * be positive, such as probabilities, magnitudes, and physical measurements.\n */\nexport const PositiveFiniteNumber = {\n  /**\n   * Type guard to check if a value is a PositiveFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a positive finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a positive finite number.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smaller of two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns The minimum value as a PositiveFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns The maximum value as a PositiveFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the positive finite range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  clamp,\n\n  /**\n   * Rounds down a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round down.\n   * @returns The floor value as a Uint (can be 0).\n   */\n  floor,\n\n  /**\n   * Rounds up a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round up.\n   * @returns The ceiling value as a PositiveInt (always >= 1).\n   */\n  ceil,\n\n  /**\n   * Rounds a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round.\n   * @returns The rounded value as a Uint (can be 0 if x < 0.5).\n   */\n  round,\n\n  /**\n   * Generates a random PositiveFiniteNumber value.\n   *\n   * @returns A random positive finite number.\n   */\n  random,\n\n  /**\n   * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.\n   *\n   * @param a The base PositiveFiniteNumber.\n   * @param b The exponent PositiveFiniteNumber.\n   * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Adds two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  add,\n\n  /**\n   * Subtracts one PositiveFiniteNumber from another.\n   *\n   * @param a The minuend PositiveFiniteNumber.\n   * @param b The subtrahend PositiveFiniteNumber.\n   * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum\n   *   MIN_VALUE).\n   */\n  sub,\n\n  /**\n   * Multiplies two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  mul,\n\n  /**\n   * Divides one PositiveFiniteNumber by another.\n   *\n   * @param a The dividend PositiveFiniteNumber.\n   * @param b The divisor PositiveFiniteNumber.\n   * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'positive'>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,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,iBAAA,CAI1C;AAAA,EACA,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAIF,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAsBK,MAAM,sBAAA,GAAyB;AAS/B,MAAM,sBAAA,GAAyB;AAW/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,EAAA;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;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,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-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":["import {\n  type PositiveInt,\n  type PositiveFiniteNumber as TtfImported_PositiveFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;\n\ntype ElementType = PositiveFiniteNumber;\n\nconst typeNameInMessage = 'a positive finite number';\n\nconst {\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.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  MIN_VALUE: Number.MIN_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  PositiveInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Uint\n>('=');\n\n/**\n * Type guard that checks if a value is a positive finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive finite number, `false` otherwise\n */\nexport const isPositiveFiniteNumber = is;\n\n/**\n * Casts a `number` to the `PositiveFiniteNumber` branded type.\n *\n * Validates that the value is a positive finite number and returns it with the\n * `PositiveFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveFiniteNumber`\n * @throws {TypeError} If the value is not a positive finite number\n */\nexport const asPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveFiniteNumber`\n * branded type.\n *\n * The `PositiveFiniteNumber` type represents a positive finite number.\n */\nexport const PositiveFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a positive finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive finite number, `false` otherwise\n   * @see {@link isPositiveFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveFiniteNumber`.\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The smallest value as a `PositiveFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The largest value as a `PositiveFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `PositiveFiniteNumber` range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `PositiveFiniteNumber`\n   */\n  clamp,\n\n  /**\n   * Returns the greatest integer less than or equal to a positive finite\n   * number.\n   *\n   * @param a - The positive finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a positive finite\n   * number.\n   *\n   * @param a - The positive finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a positive finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The positive finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `PositiveFiniteNumber` 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 `PositiveFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The base positive finite number\n   * @param b - The exponent positive finite number\n   * @returns `a ** b` as a `PositiveFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two positive finite numbers, returning `a + b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two positive finite numbers, returning `a - b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive finite numbers, returning `a * b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The product of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two positive finite numbers, returning `a / b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `PositiveFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'positive'>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,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,iBAAA,CAI1C;AAAA,EACA,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAIF,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAyBK,MAAM,sBAAA,GAAyB;AAY/B,MAAM,sBAAA,GAAyB;AAQ/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,EAAA;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,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,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;AAAA,EAUA,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,EAUA;AACF;;;;"}

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

@@ -3,8 +3,8 @@ export type PositiveInt = TtfImported_PositiveInt;
 /**
  * Type guard that checks if a value is a positive integer.
  *
- * A positive integer is any integer greater than zero (>= 1). This excludes
- * zero, negative numbers, and non-integers.
+ * Returns `true` for a positive integer — a value with no fractional component,
+ * including values outside the safe integer range (unlike `SafeInt`).
  *
  * @example
  *
@@ -21,11 +21,10 @@ export type PositiveInt = TtfImported_PositiveInt;
  */
 export declare const isPositiveInt: (a: number) => a is TtfImported_PositiveInt;
 /**
- * Casts a number to a PositiveInt branded type.
+ * Casts a `number` to the `PositiveInt` branded type.
  *
- * This function validates that the input is a positive integer (>= 1) and
- * returns it with the PositiveInt brand. This ensures type safety for
- * operations that require strictly positive integer values.
+ * Validates that the value is a positive integer and returns it with the
+ * `PositiveInt` brand. Throws a `TypeError` otherwise.
  *
  * @example
  *
@@ -38,7 +37,7 @@ export declare const isPositiveInt: (a: number) => a is TtfImported_PositiveInt;
  * ```
  *
  * @param value - The value to cast
- * @returns The value as a PositiveInt branded type
+ * @returns The value as a `PositiveInt`
  * @throws {TypeError} If the value is not a positive integer
  */
 export declare const asPositiveInt: <N extends number>(x: N) => number & {
@@ -56,20 +55,14 @@ export declare const asPositiveInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe operations for PositiveInt branded types.
+ * Namespace providing type-safe operations for the `PositiveInt` branded type.
  *
- * PositiveInt represents integers that are strictly greater than zero (>= 1).
- * All operations automatically clamp results to maintain the positive
- * constraint, ensuring that arithmetic operations never produce zero or
- * negative values.
+ * The `PositiveInt` type represents a positive integer. Division (`div`) uses
+ * floor division.
  *
- * This type is essential for:
- *
- * - Array lengths and sizes (length >= 1)
- * - Counts and quantities that must be positive
- * - Denominators in division operations
- * - Loop counters and iteration counts
- * - Database primary keys and IDs
+ * Unlike `SafeInt`, `PositiveInt` allows values outside the safe integer range
+ * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's
+ * `number` type.
  */
 export declare const PositiveInt: {
     /**
@@ -91,16 +84,11 @@ export declare const PositiveInt: {
      */
     readonly is: (a: number) => a is TtfImported_PositiveInt;
     /**
-     * The minimum value for a PositiveInt.
-     *
-     * @readonly
+     * The smallest value representable as `PositiveInt`.
      */
     readonly MIN_VALUE: 1;
     /**
-     * Returns the minimum value from a list of positive integers.
-     *
-     * Since all inputs are guaranteed to be >= 1, the result is also guaranteed
-     * to be a positive integer.
+     * Returns the smallest of the given positive integers.
      *
      * @example
      *
@@ -115,11 +103,11 @@ export declare const PositiveInt: {
      * ```
      *
      * @param values - The positive integers to compare (at least one required)
-     * @returns The smallest value as a PositiveInt
+     * @returns The smallest value as a `PositiveInt`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>[]) => TtfImported_PositiveInt;
     /**
-     * Returns the maximum value from a list of positive integers.
+     * Returns the largest of the given positive integers.
      *
      * @example
      *
@@ -134,14 +122,12 @@ export declare const PositiveInt: {
      * ```
      *
      * @param values - The positive integers to compare (at least one required)
-     * @returns The largest value as a PositiveInt
+     * @returns The largest value as a `PositiveInt`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>[]) => TtfImported_PositiveInt;
     /**
-     * Clamps a number to the positive integer range.
-     *
-     * Since PositiveInt has a minimum value of 1, this function ensures that any
-     * input less than 1 is clamped to 1.
+     * Clamps a `number` into the `PositiveInt` range, rounding to the nearest
+     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
      * @example
      *
@@ -155,15 +141,14 @@ export declare const PositiveInt: {
      * assert.isTrue(withinRange === 10);
      * ```
      *
-     * @param value - The number to clamp
-     * @returns The value clamped to >= 1 as a PositiveInt
+     * @param value - The value to clamp
+     * @returns The clamped value as a `PositiveInt`
      */
     readonly clamp: (x: number) => TtfImported_PositiveInt;
     /**
-     * Generates a random positive integer within the specified range (inclusive).
+     * Generates a random `PositiveInt` within the given range.
      *
-     * Both bounds are inclusive, and both min and max must be positive integers.
-     * If min > max, they are automatically swapped.
+     * The range is inclusive on both ends.
      *
      * @example
      *
@@ -179,14 +164,14 @@ export declare const PositiveInt: {
      * assert.isTrue(randomValue >= 3 && randomValue <= 6);
      * ```
      *
-     * @param min - The minimum value (inclusive, must be >= 1)
-     * @param max - The maximum value (inclusive, must be >= min)
-     * @returns A random PositiveInt in the range [min, max]
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `PositiveInt` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt> | undefined) => TtfImported_PositiveInt;
     /**
-     * Raises a positive integer to a power, ensuring the result is never less
-     * than 1.
+     * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt` (floored
+     * to an integer).
      *
      * @example
      *
@@ -202,11 +187,11 @@ export declare const PositiveInt: {
      *
      * @param a - The base positive integer
      * @param b - The exponent positive integer
-     * @returns `a ** b` as a PositiveInt, but never less than 1
+     * @returns `a ** b` as a `PositiveInt`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>) => TtfImported_PositiveInt;
     /**
-     * Adds two positive integers, ensuring the result is never less than 1.
+     * Adds two positive integers, returning `a + b` as a `PositiveInt`.
      *
      * @example
      *
@@ -216,16 +201,13 @@ export declare const PositiveInt: {
      * assert.isTrue(sum === 9);
      * ```
      *
-     * @param a - First positive integer
-     * @param b - Second positive integer
-     * @returns `a + b` as a PositiveInt, but never less than 1
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The sum of `a` and `b` as a `PositiveInt`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>) => TtfImported_PositiveInt;
     /**
-     * Subtracts two positive integers, clamping the result to remain positive.
-     *
-     * If the mathematical result would be <= 0, it is clamped to 1 to maintain
-     * the positive integer constraint.
+     * Subtracts two positive integers, returning `a - b` as a `PositiveInt`.
      *
      * @example
      *
@@ -235,13 +217,13 @@ export declare const PositiveInt: {
      * assert.isTrue(difference === 1);
      * ```
      *
-     * @param a - The minuend (positive integer)
-     * @param b - The subtrahend (positive integer)
-     * @returns `max(1, a - b)` as a PositiveInt
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The difference of `a` and `b` as a `PositiveInt`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>) => TtfImported_PositiveInt;
     /**
-     * Multiplies two positive integers, ensuring the result is never less than 1.
+     * Multiplies two positive integers, returning `a * b` as a `PositiveInt`.
      *
      * @example
      *
@@ -251,18 +233,14 @@ export declare const PositiveInt: {
      * assert.isTrue(product === 21);
      * ```
      *
-     * @param a - First positive integer
-     * @param b - Second positive integer
-     * @returns `a * b` as a PositiveInt, but never less than 1
+     * @param a - The first positive integer
+     * @param b - The second positive integer
+     * @returns The product of `a` and `b` as a `PositiveInt`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>) => TtfImported_PositiveInt;
     /**
-     * Divides two positive integers using floor division, clamping to remain
-     * positive.
-     *
-     * Performs mathematical floor division: `⌊a / b⌋`. If the result would be 0
-     * (when a < b), it is clamped to 1 to maintain the positive integer
-     * constraint.
+     * Divides two positive integers using floor division (`⌊a / b⌋`): the result
+     * is `a / b` rounded toward negative infinity, as a `PositiveInt`.
      *
      * @example
      *
@@ -276,9 +254,9 @@ export declare const PositiveInt: {
      * assert.isTrue(clamped === 1);
      * ```
      *
-     * @param a - The dividend (positive integer)
-     * @param b - The divisor (positive integer, guaranteed non-zero)
-     * @returns `max(1, ⌊a / b⌋)` as a PositiveInt
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as a `PositiveInt`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_PositiveInt>, 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-int.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"positive-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,IAAI,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAI5E,MAAM,MAAM,WAAW,GAAG,uBAAuB,CAAC;AA8BlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,aAAa,6CAAK,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;MAAW,CAAC;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,WAAW;IACtB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;OAIG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;;;OAoBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;OAuBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;OAuBG;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,IAAI,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAI5E,MAAM,MAAM,WAAW,GAAG,uBAAuB,CAAC;AA8BlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,aAAa,6CAAK,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;MAAW,CAAC;AAEtC;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;IACtB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;OAEG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;;;OAmBG;;;;;;;;;;;;;;;CAEK,CAAC"}

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

@@ -42,16 +42,11 @@ const PositiveInt = {
    */
   is,
   /**
-   * The minimum value for a PositiveInt.
-   *
-   * @readonly
+   * The smallest value representable as `PositiveInt`.
    */
   MIN_VALUE,
   /**
-   * Returns the minimum value from a list of positive integers.
-   *
-   * Since all inputs are guaranteed to be >= 1, the result is also guaranteed
-   * to be a positive integer.
+   * Returns the smallest of the given positive integers.
    *
    * @example
    *
@@ -66,11 +61,11 @@ const PositiveInt = {
    * ```
    *
    * @param values - The positive integers to compare (at least one required)
-   * @returns The smallest value as a PositiveInt
+   * @returns The smallest value as a `PositiveInt`
    */
   min: min_,
   /**
-   * Returns the maximum value from a list of positive integers.
+   * Returns the largest of the given positive integers.
    *
    * @example
    *
@@ -85,14 +80,12 @@ const PositiveInt = {
    * ```
    *
    * @param values - The positive integers to compare (at least one required)
-   * @returns The largest value as a PositiveInt
+   * @returns The largest value as a `PositiveInt`
    */
   max: max_,
   /**
-   * Clamps a number to the positive integer range.
-   *
-   * Since PositiveInt has a minimum value of 1, this function ensures that any
-   * input less than 1 is clamped to 1.
+   * Clamps a `number` into the `PositiveInt` range, rounding to the nearest
+   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
    * @example
    *
@@ -106,15 +99,14 @@ const PositiveInt = {
    * assert.isTrue(withinRange === 10);
    * ```
    *
-   * @param value - The number to clamp
-   * @returns The value clamped to >= 1 as a PositiveInt
+   * @param value - The value to clamp
+   * @returns The clamped value as a `PositiveInt`
    */
   clamp,
   /**
-   * Generates a random positive integer within the specified range (inclusive).
+   * Generates a random `PositiveInt` within the given range.
    *
-   * Both bounds are inclusive, and both min and max must be positive integers.
-   * If min > max, they are automatically swapped.
+   * The range is inclusive on both ends.
    *
    * @example
    *
@@ -130,14 +122,14 @@ const PositiveInt = {
    * assert.isTrue(randomValue >= 3 && randomValue <= 6);
    * ```
    *
-   * @param min - The minimum value (inclusive, must be >= 1)
-   * @param max - The maximum value (inclusive, must be >= min)
-   * @returns A random PositiveInt in the range [min, max]
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `PositiveInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a positive integer to a power, ensuring the result is never less
-   * than 1.
+   * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt` (floored
+   * to an integer).
    *
    * @example
    *
@@ -153,11 +145,11 @@ const PositiveInt = {
    *
    * @param a - The base positive integer
    * @param b - The exponent positive integer
-   * @returns `a ** b` as a PositiveInt, but never less than 1
+   * @returns `a ** b` as a `PositiveInt`
    */
   pow,
   /**
-   * Adds two positive integers, ensuring the result is never less than 1.
+   * Adds two positive integers, returning `a + b` as a `PositiveInt`.
    *
    * @example
    *
@@ -167,16 +159,13 @@ const PositiveInt = {
    * assert.isTrue(sum === 9);
    * ```
    *
-   * @param a - First positive integer
-   * @param b - Second positive integer
-   * @returns `a + b` as a PositiveInt, but never less than 1
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The sum of `a` and `b` as a `PositiveInt`
    */
   add,
   /**
-   * Subtracts two positive integers, clamping the result to remain positive.
-   *
-   * If the mathematical result would be <= 0, it is clamped to 1 to maintain
-   * the positive integer constraint.
+   * Subtracts two positive integers, returning `a - b` as a `PositiveInt`.
    *
    * @example
    *
@@ -186,13 +175,13 @@ const PositiveInt = {
    * assert.isTrue(difference === 1);
    * ```
    *
-   * @param a - The minuend (positive integer)
-   * @param b - The subtrahend (positive integer)
-   * @returns `max(1, a - b)` as a PositiveInt
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The difference of `a` and `b` as a `PositiveInt`
    */
   sub,
   /**
-   * Multiplies two positive integers, ensuring the result is never less than 1.
+   * Multiplies two positive integers, returning `a * b` as a `PositiveInt`.
    *
    * @example
    *
@@ -202,18 +191,14 @@ const PositiveInt = {
    * assert.isTrue(product === 21);
    * ```
    *
-   * @param a - First positive integer
-   * @param b - Second positive integer
-   * @returns `a * b` as a PositiveInt, but never less than 1
+   * @param a - The first positive integer
+   * @param b - The second positive integer
+   * @returns The product of `a` and `b` as a `PositiveInt`
    */
   mul,
   /**
-   * Divides two positive integers using floor division, clamping to remain
-   * positive.
-   *
-   * Performs mathematical floor division: `⌊a / b⌋`. If the result would be 0
-   * (when a < b), it is clamped to 1 to maintain the positive integer
-   * constraint.
+   * Divides two positive integers using floor division (`⌊a / b⌋`): the result
+   * is `a / b` rounded toward negative infinity, as a `PositiveInt`.
    *
    * @example
    *
@@ -227,9 +212,9 @@ const PositiveInt = {
    * assert.isTrue(clamped === 1);
    * ```
    *
-   * @param a - The dividend (positive integer)
-   * @param b - The divisor (positive integer, guaranteed non-zero)
-   * @returns `max(1, ⌊a / b⌋)` as a PositiveInt
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `PositiveInt`
    */
   div
 };