ts-data-forge 10.0.0 → 11.0.1

package/dist/guard/index.mjs

@@ -1,7 +1,4 @@
-export { asBoundedLengthArray, asFixedLengthArray, asMaxLengthArray, asMinLengthArray } from './as-length-bounded-array.mjs';
 export { hasKey } from './has-key.mjs';
-export { isBoundedLengthArray, isFixedLengthArray, isMaxLengthArray, isMinLengthArray } from './is-length-bounded-array.mjs';
-export { isBoundedLengthString, isFixedLengthString, isMaxLengthString, isMinLengthString } from './is-length-bounded-string.mjs';
 export { isNonEmptyString } from './is-non-empty-string.mjs';
 export { isNonNullObject } from './is-non-null-object.mjs';
 export { isPrimitive } from './is-primitive.mjs';

package/dist/guard/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}

package/dist/index.d.mts

@@ -7,5 +7,6 @@ export * from './number/index.mjs';
 export * from './object/index.mjs';
 export * from './others/index.mjs';
 export * from './promise/index.mjs';
+export * from './string/index.mjs';
 export * from './types.mjs';
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC"}

package/dist/index.mjs

@@ -5,10 +5,7 @@ export { ISet } from './collections/iset.mjs';
 export { createQueue } from './collections/queue.mjs';
 export { createStack } from './collections/stack.mjs';
 export { expectType } from './expect-type.mjs';
-export { asBoundedLengthArray, asFixedLengthArray, asMaxLengthArray, asMinLengthArray } from './guard/as-length-bounded-array.mjs';
 export { hasKey } from './guard/has-key.mjs';
-export { isBoundedLengthArray, isFixedLengthArray, isMaxLengthArray, isMinLengthArray } from './guard/is-length-bounded-array.mjs';
-export { isBoundedLengthString, isFixedLengthString, isMaxLengthString, isMinLengthString } from './guard/is-length-bounded-string.mjs';
 export { isNonEmptyString } from './guard/is-non-empty-string.mjs';
 export { isNonNullObject } from './guard/is-non-null-object.mjs';
 export { isPrimitive } from './guard/is-primitive.mjs';
@@ -64,4 +61,5 @@ export { memoizeFunction } from './others/memoize-function.mjs';
 export { tp } from './others/tuple.mjs';
 export { unknownToString } from './others/unknown-to-string.mjs';
 export { createPromise } from './promise/promise.mjs';
+export { Str } from './string/str.mjs';
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

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

@@ -5,24 +5,22 @@ type ElementType = FiniteNumber;
 /**
  * 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.
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
  *
  * @param value - The value to check
- * @returns `true` if the value is finite, `false` otherwise
+ * @returns `true` if the value is a finite number, `false` otherwise
  */
 export declare const isFiniteNumber: (a: number) => a is TtfImported_FiniteNumber;
 /**
- * Casts a number to a FiniteNumber branded type.
+ * Casts a `number` to the `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.
+ * Validates that the value is a finite number and returns it with the
+ * `FiniteNumber` brand. Throws a `TypeError` otherwise.
  *
  * @param value - The value to cast
- * @returns The value as a FiniteNumber branded type
- * @throws {TypeError} If the value is NaN, Infinity, or -Infinity
+ * @returns The value as a `FiniteNumber`
+ * @throws {TypeError} If the value is not a finite number
  */
 export declare const asFiniteNumber: <N extends number>(x: N) => number & {
     readonly Finite: true;
@@ -31,123 +29,111 @@ export declare const asFiniteNumber: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe operations for FiniteNumber branded types.
+ * Namespace providing type-safe operations for the `FiniteNumber` branded type.
  *
- * 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
+ * The `FiniteNumber` type represents a finite number.
  */
 export declare 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
+     * @returns `true` if the value is a finite number, `false` otherwise
      * @see {@link isFiniteNumber} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_FiniteNumber;
     /**
      * 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
+     * The result is non-negative and keeps the `FiniteNumber` brand.
+     *
+     * @param a - The finite number value
+     * @returns The absolute value as a non-negative `FiniteNumber`
      */
     readonly abs: (x: TtfImported_FiniteNumber) => import("ts-type-forge").IntersectBrand<TtfImported_FiniteNumber, import("ts-type-forge").NonNegativeNumber>;
     /**
-     * Returns the minimum value from a list of finite numbers.
+     * Returns the smallest of the given finite numbers.
      *
      * @param values - The finite numbers to compare (at least one required)
-     * @returns The smallest value as a FiniteNumber
+     * @returns The smallest value as a `FiniteNumber`
      */
     readonly min: (...values: readonly TtfImported_FiniteNumber[]) => TtfImported_FiniteNumber;
     /**
-     * Returns the maximum value from a list of finite numbers.
+     * Returns the largest of the given finite numbers.
      *
      * @param values - The finite numbers to compare (at least one required)
-     * @returns The largest value as a FiniteNumber
+     * @returns The largest value as a `FiniteNumber`
      */
     readonly max: (...values: readonly TtfImported_FiniteNumber[]) => TtfImported_FiniteNumber;
     /**
-     * Returns the largest integer less than or equal to the given finite number.
+     * Returns the greatest integer less than or equal to a finite number.
      *
-     * @param x - The finite number to floor
-     * @returns The floor value as an Int
+     * @param a - The finite number value
+     * @returns The floored value as an integer
      */
     readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Returns the smallest integer greater than or equal to the given finite
-     * number.
+     * Returns the smallest integer greater than or equal to a finite number.
      *
-     * @param x - The finite number to ceil
-     * @returns The ceiling value as an Int
+     * @param a - The finite number value
+     * @returns The ceiled value as an integer
      */
     readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Rounds a finite number to the nearest integer.
+     * Returns the value of a finite number rounded to the nearest integer.
      *
-     * @param x - The finite number to round
-     * @returns The rounded value as an Int
+     * @param a - The finite number value
+     * @returns The rounded value as an integer
      */
     readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Generates a random finite number within the specified range.
+     * Generates a random `FiniteNumber` within the given range.
      *
-     * The generated value is uniformly distributed in the range [min, max]. Both
-     * bounds are inclusive.
+     * The range is inclusive on both ends.
      *
      * @param min - The minimum value (inclusive)
      * @param max - The maximum value (inclusive)
-     * @returns A random FiniteNumber in the range [min, max]
+     * @returns A random `FiniteNumber` in `[min, max]`
      */
     readonly random: (min?: TtfImported_FiniteNumber | undefined, max?: TtfImported_FiniteNumber | undefined) => TtfImported_FiniteNumber;
     /**
-     * Raises a finite number to a power.
+     * Raises `a` to the power `b`, returning `a ** b` as a `FiniteNumber`.
      *
      * @param a - The base finite number
      * @param b - The exponent finite number
-     * @returns `a ** b` as a FiniteNumber
+     * @returns `a ** b` as a `FiniteNumber`
      */
     readonly pow: (x: TtfImported_FiniteNumber, y: TtfImported_FiniteNumber) => TtfImported_FiniteNumber;
     /**
-     * Adds two finite numbers.
+     * Adds two finite numbers, returning `a + b` as a `FiniteNumber`.
      *
-     * @param a - First finite number
-     * @param b - Second finite number
-     * @returns `a + b` as a FiniteNumber
+     * @param a - The first finite number
+     * @param b - The second finite number
+     * @returns The sum of `a` and `b` as a `FiniteNumber`
      */
     readonly add: (x: TtfImported_FiniteNumber, y: TtfImported_FiniteNumber) => TtfImported_FiniteNumber;
     /**
-     * Subtracts two finite numbers.
+     * Subtracts two finite numbers, returning `a - b` as a `FiniteNumber`.
      *
-     * @param a - First finite number
-     * @param b - Second finite number
-     * @returns `a - b` as a FiniteNumber
+     * @param a - The first finite number
+     * @param b - The second finite number
+     * @returns The difference of `a` and `b` as a `FiniteNumber`
      */
     readonly sub: (x: TtfImported_FiniteNumber, y: TtfImported_FiniteNumber) => TtfImported_FiniteNumber;
     /**
-     * Multiplies two finite numbers.
+     * Multiplies two finite numbers, returning `a * b` as a `FiniteNumber`.
      *
-     * @param a - First finite number
-     * @param b - Second finite number
-     * @returns `a * b` as a FiniteNumber
+     * @param a - The first finite number
+     * @param b - The second finite number
+     * @returns The product of `a` and `b` as a `FiniteNumber`
      */
     readonly mul: (x: TtfImported_FiniteNumber, y: TtfImported_FiniteNumber) => TtfImported_FiniteNumber;
     /**
-     * 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.
+     * Divides two finite numbers, returning `a / b` as a `FiniteNumber`.
      *
      * @param a - The dividend
      * @param b - The divisor (must be non-zero)
-     * @returns The quotient `a / b` as a FiniteNumber
+     * @returns `a / b` as a `FiniteNumber`
      */
     readonly div: (x: TtfImported_FiniteNumber, y: number & {
         readonly "!=0": true;

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

@@ -1 +1 @@
-{"version":3,"file":"finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,YAAY,IAAI,wBAAwB,EAC9C,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,YAAY,GAAG,wBAAwB,CAAC;AAEpD,KAAK,WAAW,GAAG,YAAY,CAAC;AAgDhC;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,8CAAK,CAAC;AAEjC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc;;;;;MAAW,CAAC;AAEvC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;wBAlGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAoG3D;;;;;;OAMG;uBArGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAuG3D;;;;;OAKG;wBAvGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAyG3D;;;;;;;;;OASG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;;OAUG;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,YAAY,IAAI,wBAAwB,EAC9C,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,YAAY,GAAG,wBAAwB,CAAC;AAEpD,KAAK,WAAW,GAAG,YAAY,CAAC;AAgDhC;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,8CAAK,CAAC;AAEjC;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc;;;;;MAAW,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;wBA1FA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IA4F3D;;;;;OAKG;uBA5FA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IA8F3D;;;;;OAKG;wBA9FA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAgG3D;;;;;;;;OAQG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;CAEK,CAAC"}

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

@@ -37,106 +37,102 @@ 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
+   * @returns `true` if the value is a finite number, `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
+   * The result is non-negative and keeps the `FiniteNumber` brand.
+   *
+   * @param a - The finite number value
+   * @returns The absolute value as a non-negative `FiniteNumber`
    */
   abs,
   /**
-   * Returns the minimum value from a list of finite numbers.
+   * Returns the smallest of the given finite numbers.
    *
    * @param values - The finite numbers to compare (at least one required)
-   * @returns The smallest value as a FiniteNumber
+   * @returns The smallest value as a `FiniteNumber`
    */
   min: min_,
   /**
-   * Returns the maximum value from a list of finite numbers.
+   * Returns the largest of the given finite numbers.
    *
    * @param values - The finite numbers to compare (at least one required)
-   * @returns The largest value as a FiniteNumber
+   * @returns The largest value as a `FiniteNumber`
    */
   max: max_,
   /**
-   * Returns the largest integer less than or equal to the given finite number.
+   * Returns the greatest integer less than or equal to a finite number.
    *
-   * @param x - The finite number to floor
-   * @returns The floor value as an Int
+   * @param a - The finite number value
+   * @returns The floored value as an integer
    */
   floor,
   /**
-   * Returns the smallest integer greater than or equal to the given finite
-   * number.
+   * Returns the smallest integer greater than or equal to a finite number.
    *
-   * @param x - The finite number to ceil
-   * @returns The ceiling value as an Int
+   * @param a - The finite number value
+   * @returns The ceiled value as an integer
    */
   ceil,
   /**
-   * Rounds a finite number to the nearest integer.
+   * Returns the value of a finite number rounded to the nearest integer.
    *
-   * @param x - The finite number to round
-   * @returns The rounded value as an Int
+   * @param a - The finite number value
+   * @returns The rounded value as an integer
    */
   round,
   /**
-   * Generates a random finite number within the specified range.
+   * Generates a random `FiniteNumber` within the given range.
    *
-   * The generated value is uniformly distributed in the range [min, max]. Both
-   * bounds are inclusive.
+   * The range is inclusive on both ends.
    *
    * @param min - The minimum value (inclusive)
    * @param max - The maximum value (inclusive)
-   * @returns A random FiniteNumber in the range [min, max]
+   * @returns A random `FiniteNumber` in `[min, max]`
    */
   random,
   /**
-   * Raises a finite number to a power.
+   * Raises `a` to the power `b`, returning `a ** b` as a `FiniteNumber`.
    *
    * @param a - The base finite number
    * @param b - The exponent finite number
-   * @returns `a ** b` as a FiniteNumber
+   * @returns `a ** b` as a `FiniteNumber`
    */
   pow,
   /**
-   * Adds two finite numbers.
+   * Adds two finite numbers, returning `a + b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a + b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The sum of `a` and `b` as a `FiniteNumber`
    */
   add,
   /**
-   * Subtracts two finite numbers.
+   * Subtracts two finite numbers, returning `a - b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a - b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The difference of `a` and `b` as a `FiniteNumber`
    */
   sub,
   /**
-   * Multiplies two finite numbers.
+   * Multiplies two finite numbers, returning `a * b` as a `FiniteNumber`.
    *
-   * @param a - First finite number
-   * @param b - Second finite number
-   * @returns `a * b` as a FiniteNumber
+   * @param a - The first finite number
+   * @param b - The second finite number
+   * @returns The product of `a` and `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.
+   * Divides two finite numbers, returning `a / b` as a `FiniteNumber`.
    *
    * @param a - The dividend
    * @param b - The divisor (must be non-zero)
-   * @returns The quotient `a / b` as a FiniteNumber
+   * @returns `a / b` as a `FiniteNumber`
    */
   div
 };

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":["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;;;;"}
+{"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` 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 finite number, `false` otherwise\n */\nexport const isFiniteNumber = is;\n\n/**\n * Casts a `number` to the `FiniteNumber` branded type.\n *\n * Validates that the value is a finite number and returns it with the\n * `FiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `FiniteNumber`\n * @throws {TypeError} If the value is not a finite number\n */\nexport const asFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `FiniteNumber` branded type.\n *\n * The `FiniteNumber` type represents a finite number.\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 a finite number, `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   * The result is non-negative and keeps the `FiniteNumber` brand.\n   *\n   * @param a - The finite number value\n   * @returns The absolute value as a non-negative `FiniteNumber`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given 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 largest of the given 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 greatest integer less than or equal to a finite number.\n   *\n   * @param a - The 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 finite number.\n   *\n   * @param a - The finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a finite number rounded to the nearest integer.\n   *\n   * @param a - The finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `FiniteNumber` 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 `FiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `FiniteNumber`.\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, returning `a + b` as a `FiniteNumber`.\n   *\n   * @param a - The first finite number\n   * @param b - The second finite number\n   * @returns The sum of `a` and `b` as a `FiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two finite numbers, returning `a - b` as a `FiniteNumber`.\n   *\n   * @param a - The first finite number\n   * @param b - The second finite number\n   * @returns The difference of `a` and `b` as a `FiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two finite numbers, returning `a * b` as a `FiniteNumber`.\n   *\n   * @param a - The first finite number\n   * @param b - The second finite number\n   * @returns The product of `a` and `b` as a `FiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two finite numbers, returning `a / b` as a `FiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `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;AAeP,MAAM,cAAA,GAAiB;AAYvB,MAAM,cAAA,GAAiB;AAOvB,MAAM,YAAA,GAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ1B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,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,EAQA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,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,EASA;AACF;;;;"}