ts-data-forge 11.0.0 → 11.0.1

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"non-positive-finite-number.mjs","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"sourcesContent":["import { type NonPositiveFiniteNumber as TtfImported_NonPositiveFiniteNumber } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonPositiveFiniteNumber = TtfImported_NonPositiveFiniteNumber;\n\ntype ElementType = NonPositiveFiniteNumber;\n\nconst typeNameInMessage = 'a non-positive finite number';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  0\n>({\n  MIN_VALUE: Number.MAX_VALUE * -1,\n  MAX_VALUE: 0,\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.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\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\n/**\n * Checks if a number is a NonPositiveFiniteNumber (a finite number <= 0).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonPositiveFiniteNumber, `false` otherwise.\n */\nexport const isNonPositiveFiniteNumber = is;\n\n/**\n * Casts a number to a NonPositiveFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a NonPositiveFiniteNumber type.\n * @throws {TypeError} If the value is not a non-positive finite number.\n */\nexport const asNonPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for non-positive finite\n * numbers.\n *\n * All operations maintain the non-positive constraint by clamping positive\n * results to MAX_VALUE (0), while ensuring results remain finite (excluding NaN\n * and Infinity). This type is useful for representing quantities that must\n * always be non-positive, such as debts, penalties, and negative offsets.\n */\nexport const NonPositiveFiniteNumber = {\n  /**\n   * Type guard to check if a value is a NonPositiveFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-positive finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The maximum value for a non-positive finite number.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two NonPositiveFiniteNumber values.\n   *\n   * @param a The first NonPositiveFiniteNumber.\n   * @param b The second NonPositiveFiniteNumber.\n   * @returns The minimum value as a NonPositiveFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonPositiveFiniteNumber values.\n   *\n   * @param a The first NonPositiveFiniteNumber.\n   * @param b The second NonPositiveFiniteNumber.\n   * @returns The maximum value as a NonPositiveFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the non-positive finite range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.\n   */\n  clamp,\n\n  /**\n   * Rounds down a NonPositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The NonPositiveFiniteNumber to round down.\n   * @returns The floor value as a NonPositiveInt (can be 0).\n   */\n  floor,\n\n  /**\n   * Rounds up a NonPositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The NonPositiveFiniteNumber to round up.\n   * @returns The ceiling value as a NegativeInt (always <= -1) or 0.\n   */\n  ceil,\n\n  /**\n   * Rounds a NonPositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The NonPositiveFiniteNumber to round.\n   * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).\n   */\n  round,\n\n  /**\n   * Generates a random NonPositiveFiniteNumber value.\n   *\n   * @returns A random non-positive finite number.\n   */\n  random,\n\n  /**\n   * Raises a NonPositiveFiniteNumber to the power of another NonPositiveFiniteNumber.\n   *\n   * @param a The base NonPositiveFiniteNumber.\n   * @param b The exponent NonPositiveFiniteNumber.\n   * @returns `a ** b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Adds two NonPositiveFiniteNumber values.\n   *\n   * @param a The first NonPositiveFiniteNumber.\n   * @param b The second NonPositiveFiniteNumber.\n   * @returns `a + b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.\n   */\n  add,\n\n  /**\n   * Subtracts one NonPositiveFiniteNumber from another.\n   *\n   * @param a The minuend NonPositiveFiniteNumber.\n   * @param b The subtrahend NonPositiveFiniteNumber.\n   * @returns `a - b` clamped to (-∞, 0] as a NonPositiveFiniteNumber (maximum 0).\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;AAOA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,OAAO,SAAA,GAAY,EAAA;AAAA,EAC9B,SAAA,EAAW,CAAA;AAAA,EACX;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,EAKA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAIb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAUK,MAAM,yBAAA,GAA4B;AASlC,MAAM,yBAAA,GAA4B;AAWlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,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,EASA;AACF;;;;"}
+{"version":3,"file":"non-positive-finite-number.mjs","sources":["../../../src/number/branded-types/non-positive-finite-number.mts"],"sourcesContent":["import { type NonPositiveFiniteNumber as TtfImported_NonPositiveFiniteNumber } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonPositiveFiniteNumber = TtfImported_NonPositiveFiniteNumber;\n\ntype ElementType = NonPositiveFiniteNumber;\n\nconst typeNameInMessage = 'a non-positive finite number';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  0\n>({\n  MIN_VALUE: Number.MAX_VALUE * -1,\n  MAX_VALUE: 0,\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.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\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\n/**\n * Type guard that checks if a value is a non-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 non-positive finite number, `false` otherwise\n */\nexport const isNonPositiveFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonPositiveFiniteNumber` branded type.\n *\n * Validates that the value is a non-positive finite number and returns it with\n * the `NonPositiveFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonPositiveFiniteNumber`\n * @throws {TypeError} If the value is not a non-positive finite number\n */\nexport const asNonPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonPositiveFiniteNumber`\n * branded type.\n *\n * The `NonPositiveFiniteNumber` type represents a non-positive finite number.\n */\nexport const NonPositiveFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-positive finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-positive finite number, `false` otherwise\n   * @see {@link isNonPositiveFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The largest value representable as `NonPositiveFiniteNumber`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-positive finite numbers.\n   *\n   * @param values - The non-positive finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonPositiveFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-positive finite numbers.\n   *\n   * @param values - The non-positive finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonPositiveFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonPositiveFiniteNumber` range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NonPositiveFiniteNumber`\n   */\n  clamp,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-positive finite\n   * number.\n   *\n   * @param a - The non-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 non-positive finite\n   * number.\n   *\n   * @param a - The non-positive finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-positive finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-positive finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonPositiveFiniteNumber` 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 `NonPositiveFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The base non-positive finite number\n   * @param b - The exponent non-positive finite number\n   * @returns `a ** b` as a `NonPositiveFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two non-positive finite numbers, returning `a + b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The first non-positive finite number\n   * @param b - The second non-positive finite number\n   * @returns The sum of `a` and `b` as a `NonPositiveFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two non-positive finite numbers, returning `a - b` as a\n   * `NonPositiveFiniteNumber`.\n   *\n   * @param a - The first non-positive finite number\n   * @param b - The second non-positive finite number\n   * @returns The difference of `a` and `b` as a `NonPositiveFiniteNumber`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;AAOA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,OAAO,SAAA,GAAY,EAAA;AAAA,EAC9B,SAAA,EAAW,CAAA;AAAA,EACX;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,EAKA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAIb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAaK,MAAM,yBAAA,GAA4B;AAYlC,MAAM,yBAAA,GAA4B;AAQlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,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;AACF;;;;"}

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

@@ -3,43 +3,22 @@ export type NonPositiveInt = TtfImported_NonPositiveInt;
 /**
  * Type guard that checks if a value is a non-positive integer.
  *
- * A non-positive integer is any integer less than or equal to zero (<= 0).
- * This includes zero and all negative integers, but excludes positive numbers
- * and non-integers.
- *
- * @example
- *
- * ```ts
- * assert.isTrue(isNonPositiveInt(0));
- *
- * assert.isTrue(isNonPositiveInt(-5));
- *
- * assert.isFalse(isNonPositiveInt(1));
- * ```
+ * Returns `true` for a non-positive integer — a value with no fractional
+ * component, including values outside the safe integer range (unlike
+ * `SafeInt`).
  *
  * @param value - The value to check
  * @returns `true` if the value is a non-positive integer, `false` otherwise
  */
 export declare const isNonPositiveInt: (a: number) => a is TtfImported_NonPositiveInt;
 /**
- * Casts a number to a NonPositiveInt branded type.
- *
- * This function validates that the input is a non-positive integer (<= 0) and
- * returns it with the NonPositiveInt brand. This ensures type safety for
- * operations that require non-positive integer values.
- *
- * @example
+ * Casts a `number` to the `NonPositiveInt` branded type.
  *
- * ```ts
- * const branded = asNonPositiveInt(-7);
- *
- * assert.isTrue(branded === -7);
- *
- * assert.isTrue(NonPositiveInt.is(branded));
- * ```
+ * Validates that the value is a non-positive integer and returns it with the
+ * `NonPositiveInt` brand. Throws a `TypeError` otherwise.
  *
  * @param value - The value to cast
- * @returns The value as a NonPositiveInt branded type
+ * @returns The value as a `NonPositiveInt`
  * @throws {TypeError} If the value is not a non-positive integer
  */
 export declare const asNonPositiveInt: <N extends number>(x: N) => number & {
@@ -55,169 +34,85 @@ export declare const asNonPositiveInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe operations for NonPositiveInt branded types.
- *
- * NonPositiveInt represents integers that are less than or equal to zero (<= 0).
- * All operations automatically clamp results to maintain the non-positive
- * constraint, ensuring that arithmetic operations never produce positive values.
+ * Namespace providing type-safe operations for the `NonPositiveInt` branded
+ * type.
  *
- * This type is essential for:
+ * The `NonPositiveInt` type represents a non-positive integer. Division (`div`)
+ * uses floor division.
  *
- * - Debts and negative balances
- * - Penalties and reductions
- * - Offsets and adjustments (downward)
- * - Negative counts or differences
- * - Depth or altitude below a reference point
+ * Unlike `SafeInt`, `NonPositiveInt` 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 NonPositiveInt: {
     /**
      * Type guard that checks if a value is a non-positive integer.
      *
-     * @example
-     *
-     * ```ts
-     * const value: number = -42;
-     *
-     * if (NonPositiveInt.is(value)) {
-     *   // value is now typed as NonPositiveInt
-     *   const debt = value;
-     * }
-     * ```
-     *
      * @param value - The value to check
      * @returns `true` if the value is a non-positive integer, `false` otherwise
+     * @see {@link isNonPositiveInt} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonPositiveInt;
     /**
-     * The maximum value for a non-positive integer.
-     *
-     * @readonly
+     * The largest value representable as `NonPositiveInt`.
      */
     readonly MAX_VALUE: 0;
     /**
-     * Returns the smaller of two non-positive integers.
-     *
-     * Since non-positive integers range from negative infinity to 0, the smaller
-     * value is the one further from zero (more negative).
-     *
-     * @example
+     * Returns the smallest of the given non-positive integers.
      *
-     * ```ts
-     * const result = NonPositiveInt.min(-5, -10);
-     *
-     * assert.strictEqual(result, -10);
-     * ```
-     *
-     * @param a - The first non-positive integer
-     * @param b - The second non-positive integer
-     * @returns The minimum value as a non-positive integer
+     * @param values - The non-positive integers to compare (at least one required)
+     * @returns The smallest value as a `NonPositiveInt`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>[]) => TtfImported_NonPositiveInt;
     /**
-     * Returns the larger of two non-positive integers.
-     *
-     * Since non-positive integers range from negative infinity to 0, the larger
-     * value is the one closer to zero (less negative).
-     *
-     * @example
-     *
-     * ```ts
-     * const result = NonPositiveInt.max(-5, -10);
-     *
-     * assert.strictEqual(result, -5);
-     * ```
+     * Returns the largest of the given non-positive integers.
      *
-     * @param a - The first non-positive integer
-     * @param b - The second non-positive integer
-     * @returns The maximum value as a non-positive integer
+     * @param values - The non-positive integers to compare (at least one required)
+     * @returns The largest value as a `NonPositiveInt`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>[]) => TtfImported_NonPositiveInt;
     /**
-     * Clamps a number to the non-positive integer range.
-     *
-     * Any positive value is clamped to 0 (the maximum non-positive integer).
-     * Negative values are preserved as long as they are valid integers.
-     *
-     * @example
-     *
-     * ```ts
-     * assert.strictEqual(NonPositiveInt.clamp(5), 0);
-     *
-     * assert.strictEqual(NonPositiveInt.clamp(-5), -5);
+     * Clamps a `number` into the `NonPositiveInt` range, rounding to the nearest
+     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
-     * assert.strictEqual(NonPositiveInt.clamp(0), 0);
-     * ```
-     *
-     * @param value - The number to clamp
-     * @returns The value clamped to the non-positive integer range
+     * @param value - The value to clamp
+     * @returns The clamped value as a `NonPositiveInt`
      */
     readonly clamp: (x: number) => TtfImported_NonPositiveInt;
     /**
-     * Generates a random non-positive integer value.
-     *
-     * @example
-     *
-     * ```ts
-     * const randomValue = NonPositiveInt.random();
+     * Generates a random `NonPositiveInt` within the given range.
      *
-     * assert.isTrue(NonPositiveInt.is(randomValue));
-     * ```
+     * The range is inclusive on both ends.
      *
-     * @returns A random non-positive integer
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonPositiveInt` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt> | undefined) => TtfImported_NonPositiveInt;
     /**
-     * Raises a non-positive integer to the power of another non-positive integer.
-     *
-     * The result is clamped to the non-positive integer range.
-     *
-     * @example
-     *
-     * ```ts
-     * const result = NonPositiveInt.pow(-2, -1);
-     * ```
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveInt`
+     * (floored to an integer).
      *
      * @param a - The base non-positive integer
      * @param b - The exponent non-positive integer
-     * @returns `a ** b` clamped to the non-positive integer range
+     * @returns `a ** b` as a `NonPositiveInt`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>) => TtfImported_NonPositiveInt;
     /**
-     * Adds two non-positive integers.
-     *
-     * The result is clamped to the non-positive integer range. If the sum is
-     * positive, it is clamped to 0.
-     *
-     * @example
-     *
-     * ```ts
-     * assert.strictEqual(NonPositiveInt.add(-5, -3), -8);
-     *
-     * assert.strictEqual(NonPositiveInt.add(-5, 10), 0);
-     * ```
+     * Adds two non-positive integers, returning `a + b` as a `NonPositiveInt`.
      *
      * @param a - The first non-positive integer
      * @param b - The second non-positive integer
-     * @returns `a + b` clamped to the non-positive integer range
+     * @returns The sum of `a` and `b` as a `NonPositiveInt`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>) => TtfImported_NonPositiveInt;
     /**
-     * Subtracts one non-positive integer from another.
-     *
-     * The result is clamped to the non-positive integer range. If the result is
-     * positive, it is clamped to 0.
+     * Subtracts two non-positive integers, returning `a - b` as a
+     * `NonPositiveInt`.
      *
-     * @example
-     *
-     * ```ts
-     * assert.strictEqual(NonPositiveInt.sub(-10, -3), -7);
-     *
-     * assert.strictEqual(NonPositiveInt.sub(-10, 5), 0);
-     * ```
-     *
-     * @param a - The minuend non-positive integer
-     * @param b - The subtrahend non-positive integer
-     * @returns `a - b` clamped to the non-positive integer range
+     * @param a - The first non-positive integer
+     * @param b - The second non-positive integer
+     * @returns The difference of `a` and `b` as a `NonPositiveInt`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveInt>) => TtfImported_NonPositiveInt;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-positive-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,IAAI,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAGlF,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AA4BxD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;MAAW,CAAC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;OAIG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;;;;;;;;;OAYG;;IAGH;;;;;;;;;;;;;;OAcG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;IAGH;;;;;;;;;;;;;;;;;OAiBG;;CAEK,CAAC"}
+{"version":3,"file":"non-positive-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,IAAI,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAGlF,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AA4BxD;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;MAAW,CAAC;AAEzC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}

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

@@ -24,151 +24,71 @@ const NonPositiveInt = {
   /**
    * Type guard that checks if a value is a non-positive integer.
    *
-   * @example
-   *
-   * ```ts
-   * const value: number = -42;
-   *
-   * if (NonPositiveInt.is(value)) {
-   *   // value is now typed as NonPositiveInt
-   *   const debt = value;
-   * }
-   * ```
-   *
    * @param value - The value to check
    * @returns `true` if the value is a non-positive integer, `false` otherwise
+   * @see {@link isNonPositiveInt} for usage examples
    */
   is,
   /**
-   * The maximum value for a non-positive integer.
-   *
-   * @readonly
+   * The largest value representable as `NonPositiveInt`.
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two non-positive integers.
-   *
-   * Since non-positive integers range from negative infinity to 0, the smaller
-   * value is the one further from zero (more negative).
+   * Returns the smallest of the given non-positive integers.
    *
-   * @example
-   *
-   * ```ts
-   * const result = NonPositiveInt.min(-5, -10);
-   *
-   * assert.strictEqual(result, -10);
-   * ```
-   *
-   * @param a - The first non-positive integer
-   * @param b - The second non-positive integer
-   * @returns The minimum value as a non-positive integer
+   * @param values - The non-positive integers to compare (at least one required)
+   * @returns The smallest value as a `NonPositiveInt`
    */
   min: min_,
   /**
-   * Returns the larger of two non-positive integers.
-   *
-   * Since non-positive integers range from negative infinity to 0, the larger
-   * value is the one closer to zero (less negative).
-   *
-   * @example
-   *
-   * ```ts
-   * const result = NonPositiveInt.max(-5, -10);
-   *
-   * assert.strictEqual(result, -5);
-   * ```
+   * Returns the largest of the given non-positive integers.
    *
-   * @param a - The first non-positive integer
-   * @param b - The second non-positive integer
-   * @returns The maximum value as a non-positive integer
+   * @param values - The non-positive integers to compare (at least one required)
+   * @returns The largest value as a `NonPositiveInt`
    */
   max: max_,
   /**
-   * Clamps a number to the non-positive integer range.
-   *
-   * Any positive value is clamped to 0 (the maximum non-positive integer).
-   * Negative values are preserved as long as they are valid integers.
-   *
-   * @example
+   * Clamps a `number` into the `NonPositiveInt` range, rounding to the nearest
+   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
-   * ```ts
-   * assert.strictEqual(NonPositiveInt.clamp(5), 0);
-   *
-   * assert.strictEqual(NonPositiveInt.clamp(-5), -5);
-   *
-   * assert.strictEqual(NonPositiveInt.clamp(0), 0);
-   * ```
-   *
-   * @param value - The number to clamp
-   * @returns The value clamped to the non-positive integer range
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonPositiveInt`
    */
   clamp,
   /**
-   * Generates a random non-positive integer value.
-   *
-   * @example
-   *
-   * ```ts
-   * const randomValue = NonPositiveInt.random();
+   * Generates a random `NonPositiveInt` within the given range.
    *
-   * assert.isTrue(NonPositiveInt.is(randomValue));
-   * ```
+   * The range is inclusive on both ends.
    *
-   * @returns A random non-positive integer
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonPositiveInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a non-positive integer to the power of another non-positive integer.
-   *
-   * The result is clamped to the non-positive integer range.
-   *
-   * @example
-   *
-   * ```ts
-   * const result = NonPositiveInt.pow(-2, -1);
-   * ```
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveInt`
+   * (floored to an integer).
    *
    * @param a - The base non-positive integer
    * @param b - The exponent non-positive integer
-   * @returns `a ** b` clamped to the non-positive integer range
+   * @returns `a ** b` as a `NonPositiveInt`
    */
   pow,
   /**
-   * Adds two non-positive integers.
-   *
-   * The result is clamped to the non-positive integer range. If the sum is
-   * positive, it is clamped to 0.
-   *
-   * @example
-   *
-   * ```ts
-   * assert.strictEqual(NonPositiveInt.add(-5, -3), -8);
-   *
-   * assert.strictEqual(NonPositiveInt.add(-5, 10), 0);
-   * ```
+   * Adds two non-positive integers, returning `a + b` as a `NonPositiveInt`.
    *
    * @param a - The first non-positive integer
    * @param b - The second non-positive integer
-   * @returns `a + b` clamped to the non-positive integer range
+   * @returns The sum of `a` and `b` as a `NonPositiveInt`
    */
   add,
   /**
-   * Subtracts one non-positive integer from another.
-   *
-   * The result is clamped to the non-positive integer range. If the result is
-   * positive, it is clamped to 0.
-   *
-   * @example
+   * Subtracts two non-positive integers, returning `a - b` as a
+   * `NonPositiveInt`.
    *
-   * ```ts
-   * assert.strictEqual(NonPositiveInt.sub(-10, -3), -7);
-   *
-   * assert.strictEqual(NonPositiveInt.sub(-10, 5), 0);
-   * ```
-   *
-   * @param a - The minuend non-positive integer
-   * @param b - The subtrahend non-positive integer
-   * @returns `a - b` clamped to the non-positive integer range
+   * @param a - The first non-positive integer
+   * @param b - The second non-positive integer
+   * @returns The difference of `a` and `b` as a `NonPositiveInt`
    */
   sub
 };