ts-data-forge 9.0.0 → 10.0.0

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

@@ -1,163 +1,144 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a finite number';
-const { abs, add, castType, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
-    MIN_VALUE: -Number.MAX_VALUE,
-    MAX_VALUE: Number.MAX_VALUE,
-    typeNameInMessage,
+const typeNameInMessage = "a finite number";
+const {
+  abs,
+  add,
+  castType,
+  div,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+  MIN_VALUE: -Number.MAX_VALUE,
+  MAX_VALUE: Number.MAX_VALUE,
+  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);
-/**
- * Type guard that checks if a value is a finite number.
- *
- * Returns `true` if the value is a finite number (not NaN, Infinity, or
- * -Infinity). This is stricter than the standard number type, which includes
- * these special values.
- *
- * @param value - The value to check
- * @returns `true` if the value is finite, `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 isFiniteNumber = is;
-/**
- * Casts a number to a FiniteNumber branded type.
- *
- * This function validates that the input is finite (not NaN, Infinity, or
- * -Infinity) and returns it with the FiniteNumber brand. This ensures type
- * safety for operations that require finite numeric values.
- *
- * @param value - The value to cast
- * @returns The value as a FiniteNumber branded type
- * @throws {TypeError} If the value is NaN, Infinity, or -Infinity
- */
 const asFiniteNumber = castType;
-/**
- * Namespace providing type-safe operations for FiniteNumber branded types.
- *
- * The FiniteNumber type represents any finite numeric value, excluding the
- * special values NaN, Infinity, and -Infinity. All operations are guaranteed to
- * maintain the finite constraint when given finite inputs.
- *
- * This type is essential for:
- *
- * - Mathematical operations that require real numbers
- * - Preventing NaN/Infinity propagation in calculations
- * - Ensuring numeric stability in algorithms
- */
 const FiniteNumber = {
-    /**
-     * Type guard that checks if a value is a finite number.
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is finite, `false` otherwise
-     * @see {@link isFiniteNumber} for usage examples
-     */
-    is,
-    /**
-     * Returns the absolute value of a finite number.
-     *
-     * @param x - The finite number to get the absolute value of
-     * @returns The absolute value as a FiniteNumber
-     */
-    abs,
-    /**
-     * Returns the minimum value from a list of finite numbers.
-     *
-     * @param values - The finite numbers to compare (at least one required)
-     * @returns The smallest value as a FiniteNumber
-     */
-    min: min_,
-    /**
-     * Returns the maximum value from a list of finite numbers.
-     *
-     * @param values - The finite numbers to compare (at least one required)
-     * @returns The largest value as a FiniteNumber
-     */
-    max: max_,
-    /**
-     * Returns the largest integer less than or equal to the given finite number.
-     *
-     * @param x - The finite number to floor
-     * @returns The floor value as an Int
-     */
-    floor,
-    /**
-     * Returns the smallest integer greater than or equal to the given finite
-     * number.
-     *
-     * @param x - The finite number to ceil
-     * @returns The ceiling value as an Int
-     */
-    ceil,
-    /**
-     * Rounds a finite number to the nearest integer.
-     *
-     * @param x - The finite number to round
-     * @returns The rounded value as an Int
-     */
-    round,
-    /**
-     * Generates a random finite number within the specified range.
-     *
-     * The generated value is uniformly distributed in the range [min, max]. Both
-     * bounds are inclusive.
-     *
-     * @param min - The minimum value (inclusive)
-     * @param max - The maximum value (inclusive)
-     * @returns A random FiniteNumber in the range [min, max]
-     */
-    random,
-    /**
-     * Raises a finite number to a power.
-     *
-     * @param a - The base finite number
-     * @param b - The exponent finite number
-     * @returns `a ** b` as a FiniteNumber
-     */
-    pow,
-    /**
-     * Adds two finite numbers.
-     *
-     * @param a - First finite number
-     * @param b - Second finite number
-     * @returns `a + b` as a FiniteNumber
-     */
-    add,
-    /**
-     * Subtracts two finite numbers.
-     *
-     * @param a - First finite number
-     * @param b - Second finite number
-     * @returns `a - b` as a FiniteNumber
-     */
-    sub,
-    /**
-     * Multiplies two finite numbers.
-     *
-     * @param a - First finite number
-     * @param b - Second finite number
-     * @returns `a * b` as a FiniteNumber
-     */
-    mul,
-    /**
-     * Divides two finite numbers.
-     *
-     * The divisor must be non-zero (enforced by type constraints). The result is
-     * guaranteed to be finite when both inputs are finite and the divisor is
-     * non-zero.
-     *
-     * @param a - The dividend
-     * @param b - The divisor (must be non-zero)
-     * @returns The quotient `a / b` as a FiniteNumber
-     */
-    div,
+  /**
+   * Type guard that checks if a value is a finite number.
+   *
+   * @param value - The value to check
+   * @returns `true` if the value is finite, `false` otherwise
+   * @see {@link isFiniteNumber} for usage examples
+   */
+  is,
+  /**
+   * Returns the absolute value of a finite number.
+   *
+   * @param x - The finite number to get the absolute value of
+   * @returns The absolute value as a FiniteNumber
+   */
+  abs,
+  /**
+   * Returns the minimum value from a list of finite numbers.
+   *
+   * @param values - The finite numbers to compare (at least one required)
+   * @returns The smallest value as a FiniteNumber
+   */
+  min: min_,
+  /**
+   * Returns the maximum value from a list of finite numbers.
+   *
+   * @param values - The finite numbers to compare (at least one required)
+   * @returns The largest value as a FiniteNumber
+   */
+  max: max_,
+  /**
+   * Returns the largest integer less than or equal to the given finite number.
+   *
+   * @param x - The finite number to floor
+   * @returns The floor value as an Int
+   */
+  floor,
+  /**
+   * Returns the smallest integer greater than or equal to the given finite
+   * number.
+   *
+   * @param x - The finite number to ceil
+   * @returns The ceiling value as an Int
+   */
+  ceil,
+  /**
+   * Rounds a finite number to the nearest integer.
+   *
+   * @param x - The finite number to round
+   * @returns The rounded value as an Int
+   */
+  round,
+  /**
+   * Generates a random finite number within the specified range.
+   *
+   * The generated value is uniformly distributed in the range [min, max]. Both
+   * bounds are inclusive.
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random FiniteNumber in the range [min, max]
+   */
+  random,
+  /**
+   * Raises a finite number to a power.
+   *
+   * @param a - The base finite number
+   * @param b - The exponent finite number
+   * @returns `a ** b` as a FiniteNumber
+   */
+  pow,
+  /**
+   * Adds two finite numbers.
+   *
+   * @param a - First finite number
+   * @param b - Second finite number
+   * @returns `a + b` as a FiniteNumber
+   */
+  add,
+  /**
+   * Subtracts two finite numbers.
+   *
+   * @param a - First finite number
+   * @param b - Second finite number
+   * @returns `a - b` as a FiniteNumber
+   */
+  sub,
+  /**
+   * Multiplies two finite numbers.
+   *
+   * @param a - First finite number
+   * @param b - Second finite number
+   * @returns `a * b` as a FiniteNumber
+   */
+  mul,
+  /**
+   * Divides two finite numbers.
+   *
+   * The divisor must be non-zero (enforced by type constraints). The result is
+   * guaranteed to be finite when both inputs are finite and the divisor is
+   * non-zero.
+   *
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The quotient `a / b` as a FiniteNumber
+   */
+  div
 };
 
 export { FiniteNumber, asFiniteNumber, isFiniteNumber };

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

@@ -1 +1 @@
-{"version":3,"file":"finite-number.mjs","sources":["../../../src/number/branded-types/finite-number.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAYA,MAAM,iBAAiB,GAAG,iBAAiB;AAE3C,MAAM,EACJ,GAAG,EACH,GAAG,EACH,QAAQ,EACR,GAAG,EACH,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,iBAAiB,CAI3D;AACA,IAAA,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS;IAC5B,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,iBAAiB;AACT,CAAA,CAAC;AAEX,MAAM,KAAK,GAAG,CACZ,CAAc;AAEd;AACA,IAAI,CAAC,KAAK,CAAC,CAAC,CAA+D;AAE7E,MAAM,IAAI,GAAG,CACX,CAAc;AAEd;AACA,IAAI,CAAC,IAAI,CAAC,CAAC,CAA+D;AAE5E,MAAM,KAAK,GAAG,CACZ,CAAc;AAEd;AACA,IAAI,CAAC,KAAK,CAAC,CAAC,CAA+D;AAM7E;;;;;;;;;AASG;AACI,MAAM,cAAc,GAAG;AAE9B;;;;;;;;;;AAUG;AACI,MAAM,cAAc,GAAG;AAE9B;;;;;;;;;;;;AAYG;AACI,MAAM,YAAY,GAAG;AAC1B;;;;;;AAMG;IACH,EAAE;AAEF;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;;;AAMG;IACH,IAAI;AAEJ;;;;;AAKG;IACH,KAAK;AAEL;;;;;;;;;AASG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;;;;;AAUG;IACH,GAAG;;;;;"}
+{"version":3,"file":"finite-number.mjs","sources":["../../../src/number/branded-types/finite-number.mts"],"sourcesContent":["import {\n  type Int,\n  type NonNegativeFiniteNumber,\n  type FiniteNumber as TtfImported_FiniteNumber,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type FiniteNumber = TtfImported_FiniteNumber;\n\ntype ElementType = FiniteNumber;\n\nconst typeNameInMessage = 'a finite number';\n\nconst {\n  abs,\n  add,\n  castType,\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.MAX_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\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.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nexpectType<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Int>(\n  '=',\n);\n\n/**\n * Type guard that checks if a value is a finite number.\n *\n * Returns `true` if the value is a finite number (not NaN, Infinity, or\n * -Infinity). This is stricter than the standard number type, which includes\n * these special values.\n *\n * @param value - The value to check\n * @returns `true` if the value is finite, `false` otherwise\n */\nexport const isFiniteNumber = is;\n\n/**\n * Casts a number to a FiniteNumber branded type.\n *\n * This function validates that the input is finite (not NaN, Infinity, or\n * -Infinity) and returns it with the FiniteNumber brand. This ensures type\n * safety for operations that require finite numeric values.\n *\n * @param value - The value to cast\n * @returns The value as a FiniteNumber branded type\n * @throws {TypeError} If the value is NaN, Infinity, or -Infinity\n */\nexport const asFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for FiniteNumber branded types.\n *\n * The FiniteNumber type represents any finite numeric value, excluding the\n * special values NaN, Infinity, and -Infinity. All operations are guaranteed to\n * maintain the finite constraint when given finite inputs.\n *\n * This type is essential for:\n *\n * - Mathematical operations that require real numbers\n * - Preventing NaN/Infinity propagation in calculations\n * - Ensuring numeric stability in algorithms\n */\nexport const FiniteNumber = {\n  /**\n   * Type guard that checks if a value is a finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is finite, `false` otherwise\n   * @see {@link isFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * Returns the absolute value of a finite number.\n   *\n   * @param x - The finite number to get the absolute value of\n   * @returns The absolute value as a FiniteNumber\n   */\n  abs,\n\n  /**\n   * Returns the minimum value from a list of finite numbers.\n   *\n   * @param values - The finite numbers to compare (at least one required)\n   * @returns The smallest value as a FiniteNumber\n   */\n  min: min_,\n\n  /**\n   * Returns the maximum value from a list of finite numbers.\n   *\n   * @param values - The finite numbers to compare (at least one required)\n   * @returns The largest value as a FiniteNumber\n   */\n  max: max_,\n\n  /**\n   * Returns the largest integer less than or equal to the given finite number.\n   *\n   * @param x - The finite number to floor\n   * @returns The floor value as an Int\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to the given finite\n   * number.\n   *\n   * @param x - The finite number to ceil\n   * @returns The ceiling value as an Int\n   */\n  ceil,\n\n  /**\n   * Rounds a finite number to the nearest integer.\n   *\n   * @param x - The finite number to round\n   * @returns The rounded value as an Int\n   */\n  round,\n\n  /**\n   * Generates a random finite number within the specified range.\n   *\n   * The generated value is uniformly distributed in the range [min, max]. Both\n   * bounds are inclusive.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random FiniteNumber in the range [min, max]\n   */\n  random,\n\n  /**\n   * Raises a finite number to a power.\n   *\n   * @param a - The base finite number\n   * @param b - The exponent finite number\n   * @returns `a ** b` as a FiniteNumber\n   */\n  pow,\n\n  /**\n   * Adds two finite numbers.\n   *\n   * @param a - First finite number\n   * @param b - Second finite number\n   * @returns `a + b` as a FiniteNumber\n   */\n  add,\n\n  /**\n   * Subtracts two finite numbers.\n   *\n   * @param a - First finite number\n   * @param b - Second finite number\n   * @returns `a - b` as a FiniteNumber\n   */\n  sub,\n\n  /**\n   * Multiplies two finite numbers.\n   *\n   * @param a - First finite number\n   * @param b - Second finite number\n   * @returns `a * b` as a FiniteNumber\n   */\n  mul,\n\n  /**\n   * Divides two finite numbers.\n   *\n   * The divisor must be non-zero (enforced by type constraints). The result is\n   * guaranteed to be finite when both inputs are finite and the divisor is\n   * non-zero.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The quotient `a / b` as a FiniteNumber\n   */\n  div,\n} as const;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToNonNegative<ElementType>,\n  NonNegativeFiniteNumber\n>('=');\n\nexpectType<\n  keyof typeof FiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, never>\n>('=');\n\nexpectType<\n  typeof FiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, never>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,iBAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;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,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAgBP,MAAM,cAAA,GAAiB;AAavB,MAAM,cAAA,GAAiB;AAevB,MAAM,YAAA,GAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ1B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA;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,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA;AACF;;;;"}

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

@@ -43,9 +43,9 @@ export declare const isInt: (a: number) => a is TtfImported_Int;
  * @throws {TypeError} If the value is not an integer
  */
 export declare const asInt: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
     readonly Finite: true;
     readonly Int: true;
+    readonly NaNValue: false;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
@@ -247,11 +247,11 @@ export declare const Int: {
      * @param b - The divisor (must be non-zero)
      * @returns The integer quotient as an Int
      */
-    readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int>, y: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 10 | 20 | 30 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | -1 | -2 | -40 | -3 | -4 | -5 | -6 | -7 | -8 | -9 | -11 | -10 | -20 | -30 | -12 | -13 | -14 | -15 | -16 | -17 | -18 | -19 | -21 | -22 | -23 | -24 | -25 | -26 | -27 | -28 | -29 | -31 | -32 | -33 | -34 | -35 | -36 | -37 | -38 | -39 | import("ts-type-forge").NormalizeBrandUnion<number & {
-        readonly NaNValue: false;
+    readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_Int>, y: -40 | -39 | -38 | -37 | -36 | -35 | -34 | -33 | -32 | -31 | -30 | -29 | -28 | -27 | -26 | -25 | -24 | -23 | -22 | -21 | -20 | -19 | -18 | -17 | -16 | -15 | -14 | -13 | -12 | -11 | -10 | -9 | -8 | -7 | -6 | -5 | -4 | -3 | -2 | -1 | 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;
         readonly Finite: true;
         readonly Int: true;
-        readonly "!=0": true;
+        readonly NaNValue: false;
     } & Readonly<{
         'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
     }>>) => TtfImported_Int;