ts-data-forge 11.0.0 → 12.0.0

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

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

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

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

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

@@ -5,7 +5,7 @@ const {
   MAX_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -37,91 +37,103 @@ 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` (the upper
+   * saturation target of `fromNumber`).
    */
   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.
+   * Converts an arbitrary `number` into a `NonPositiveFiniteNumber`, saturating
+   * it into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asNonPositiveFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `NonPositiveFiniteNumber` instead of
+   * throwing.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+   * @param value - The value to convert
+   * @returns The value as a `NonPositiveFiniteNumber`
    */
-  clamp,
+  fromNumber,
   /**
-   * 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  fromNumber,\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` (the upper\n   * saturation target of `fromNumber`).\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   * Converts an arbitrary `number` into a `NonPositiveFiniteNumber`, saturating\n   * it into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asNonPositiveFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `NonPositiveFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonPositiveFiniteNumber`\n   */\n  fromNumber,\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,UAAA;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;AAAA,EAMA,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;AAAA;AAAA;AAAA;AAAA,EAaL,UAAA;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;;;;"}