ts-data-forge 9.0.0 → 10.0.0

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

@@ -1,133 +1,129 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a non-positive finite number';
-const { MAX_VALUE, add, castType, clamp, is, max: max_, min: min_, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
-    MIN_VALUE: Number.MAX_VALUE * -1,
-    MAX_VALUE: 0,
-    typeNameInMessage,
+const typeNameInMessage = "a non-positive finite number";
+const {
+  MAX_VALUE,
+  add,
+  castType,
+  clamp,
+  is,
+  max: max_,
+  min: min_,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+  MIN_VALUE: Number.MAX_VALUE * -1,
+  MAX_VALUE: 0,
+  typeNameInMessage
 });
-const floor = (x) => 
-// eslint-disable-next-line total-functions/no-unsafe-type-assertion
-Math.floor(x);
-const ceil = (x) => 
-// eslint-disable-next-line total-functions/no-unsafe-type-assertion
-Math.ceil(x);
-const round = (x) => 
-// eslint-disable-next-line total-functions/no-unsafe-type-assertion
-Math.round(x);
-/**
- * Checks if a number is a NonPositiveFiniteNumber (a finite number <= 0).
- *
- * @param value The value to check.
- * @returns `true` if the value is a NonPositiveFiniteNumber, `false` otherwise.
- */
+const floor = (x) => (
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+  Math.floor(
+    x
+  )
+);
+const ceil = (x) => (
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+  Math.ceil(x)
+);
+const round = (x) => (
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+  Math.round(
+    x
+  )
+);
 const isNonPositiveFiniteNumber = is;
-/**
- * Casts a number to a NonPositiveFiniteNumber type.
- *
- * @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.
- */
 const asNonPositiveFiniteNumber = castType;
-/**
- * Namespace providing type-safe arithmetic operations for non-positive finite
- * numbers.
- *
- * 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.
- */
 const NonPositiveFiniteNumber = {
-    /**
-     * Type guard to check if a value is a NonPositiveFiniteNumber.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-positive finite number, `false`
-     *   otherwise.
-     */
-    is,
-    /**
-     * The maximum value for a non-positive finite number.
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the smaller of two NonPositiveFiniteNumber values.
-     *
-     * @param a The first NonPositiveFiniteNumber.
-     * @param b The second NonPositiveFiniteNumber.
-     * @returns The minimum value as a NonPositiveFiniteNumber.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two NonPositiveFiniteNumber values.
-     *
-     * @param a The first NonPositiveFiniteNumber.
-     * @param b The second NonPositiveFiniteNumber.
-     * @returns The maximum value as a NonPositiveFiniteNumber.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the non-positive finite range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.
-     */
-    clamp,
-    /**
-     * Rounds down a NonPositiveFiniteNumber to the nearest integer.
-     *
-     * @param x The NonPositiveFiniteNumber to round down.
-     * @returns The floor value as a NonPositiveInt (can be 0).
-     */
-    floor,
-    /**
-     * Rounds up a NonPositiveFiniteNumber to the nearest integer.
-     *
-     * @param x The NonPositiveFiniteNumber to round up.
-     * @returns The ceiling value as a NegativeInt (always <= -1) or 0.
-     */
-    ceil,
-    /**
-     * Rounds a NonPositiveFiniteNumber to the nearest integer.
-     *
-     * @param x The NonPositiveFiniteNumber to round.
-     * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
-     */
-    round,
-    /**
-     * Generates a random NonPositiveFiniteNumber value.
-     *
-     * @returns A random non-positive finite number.
-     */
-    random,
-    /**
-     * Raises a NonPositiveFiniteNumber to the power of another NonPositiveFiniteNumber.
-     *
-     * @param a The base NonPositiveFiniteNumber.
-     * @param b The exponent NonPositiveFiniteNumber.
-     * @returns `a ** b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
-     */
-    pow,
-    /**
-     * Adds two NonPositiveFiniteNumber values.
-     *
-     * @param a The first NonPositiveFiniteNumber.
-     * @param b The second NonPositiveFiniteNumber.
-     * @returns `a + b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
-     */
-    add,
-    /**
-     * Subtracts one NonPositiveFiniteNumber from another.
-     *
-     * @param a The minuend NonPositiveFiniteNumber.
-     * @param b The subtrahend NonPositiveFiniteNumber.
-     * @returns `a - b` clamped to (-∞, 0] as a NonPositiveFiniteNumber (maximum 0).
-     */
-    sub,
+  /**
+   * Type guard to check if a value is a NonPositiveFiniteNumber.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a non-positive finite number, `false`
+   *   otherwise.
+   */
+  is,
+  /**
+   * The maximum value for a non-positive finite number.
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the smaller of two NonPositiveFiniteNumber values.
+   *
+   * @param a The first NonPositiveFiniteNumber.
+   * @param b The second NonPositiveFiniteNumber.
+   * @returns The minimum value as a NonPositiveFiniteNumber.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two NonPositiveFiniteNumber values.
+   *
+   * @param a The first NonPositiveFiniteNumber.
+   * @param b The second NonPositiveFiniteNumber.
+   * @returns The maximum value as a NonPositiveFiniteNumber.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the non-positive finite range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+   */
+  clamp,
+  /**
+   * Rounds down a NonPositiveFiniteNumber to the nearest integer.
+   *
+   * @param x The NonPositiveFiniteNumber to round down.
+   * @returns The floor value as a NonPositiveInt (can be 0).
+   */
+  floor,
+  /**
+   * Rounds up a NonPositiveFiniteNumber to the nearest integer.
+   *
+   * @param x The NonPositiveFiniteNumber to round up.
+   * @returns The ceiling value as a NegativeInt (always <= -1) or 0.
+   */
+  ceil,
+  /**
+   * Rounds a NonPositiveFiniteNumber to the nearest integer.
+   *
+   * @param x The NonPositiveFiniteNumber to round.
+   * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
+   */
+  round,
+  /**
+   * Generates a random NonPositiveFiniteNumber value.
+   *
+   * @returns A random non-positive finite number.
+   */
+  random,
+  /**
+   * Raises a NonPositiveFiniteNumber to the power of another NonPositiveFiniteNumber.
+   *
+   * @param a The base NonPositiveFiniteNumber.
+   * @param b The exponent NonPositiveFiniteNumber.
+   * @returns `a ** b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+   */
+  pow,
+  /**
+   * Adds two NonPositiveFiniteNumber values.
+   *
+   * @param a The first NonPositiveFiniteNumber.
+   * @param b The second NonPositiveFiniteNumber.
+   * @returns `a + b` clamped to (-∞, 0] as a NonPositiveFiniteNumber.
+   */
+  add,
+  /**
+   * Subtracts one NonPositiveFiniteNumber from another.
+   *
+   * @param a The minuend NonPositiveFiniteNumber.
+   * @param b The subtrahend NonPositiveFiniteNumber.
+   * @returns `a - b` clamped to (-∞, 0] as a NonPositiveFiniteNumber (maximum 0).
+   */
+  sub
 };
 
 export { NonPositiveFiniteNumber, asNonPositiveFiniteNumber, isNonPositiveFiniteNumber };

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":[null],"names":[],"mappings":";;AAOA,MAAM,iBAAiB,GAAG,8BAA8B;AAExD,MAAM,EACJ,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,iBAAiB,CAI3D;AACA,IAAA,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,EAAE;AAChC,IAAA,SAAS,EAAE,CAAC;IACZ,iBAAiB;AACT,CAAA,CAAC;AAEX,MAAM,KAAK,GAAG,CACZ,CAAc;AAId;AACA,IAAI,CAAC,KAAK,CACR,CAAC,CAGF;AAEH,MAAM,IAAI,GAAG,CACX,CAAc;AAId;AACA,IAAI,CAAC,IAAI,CAAC,CAAC,CAEV;AAEH,MAAM,KAAK,GAAG,CACZ,CAAc;AAId;AACA,IAAI,CAAC,KAAK,CACR,CAAC,CAGF;AAEH;;;;;AAKG;AACI,MAAM,yBAAyB,GAAG;AAEzC;;;;;;AAMG;AACI,MAAM,yBAAyB,GAAG;AAEzC;;;;;;;;AAQG;AACI,MAAM,uBAAuB,GAAG;AACrC;;;;;;AAMG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;;AAKG;IACH,KAAK;AAEL;;;;;AAKG;IACH,IAAI;AAEJ;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;;;;;"}
+{"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;;;;"}

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

@@ -43,14 +43,14 @@ export declare const isNonPositiveInt: (a: number) => a is TtfImported_NonPositi
  * @throws {TypeError} If the value is not a non-positive integer
  */
 export declare const asNonPositiveInt: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
-    readonly "<=0": true;
     readonly "< 2^15": true;
     readonly "< 2^16": true;
     readonly "< 2^31": true;
     readonly "< 2^32": true;
+    readonly "<=0": true;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;