ts-data-forge 3.3.0 → 4.0.0

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

@@ -1,22 +1,18 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 /**
- * Checks if a number is an Int32 (32-bit signed integer in the range [-2^31, 2^31)).
+ * Checks if a number is an Int32 (32-bit signed integer in the range [-2^31,
+ * 2^31)).
+ *
  * @param value The value to check.
  * @returns `true` if the value is an Int32, `false` otherwise.
  */
 export declare const isInt32: (a: number) => a is Int32;
 /**
  * Casts a number to an Int32 type.
+ *
  * @param value The value to cast.
  * @returns The value as an Int32 type.
  * @throws {TypeError} If the value is not an integer in [-2^31, 2^31).
- * @example
- * ```typescript
- * const x = asInt32(100000); // Int32
- * const y = asInt32(-500000); // Int32
- * // asInt32(3000000000); // throws TypeError
- * // asInt32(1.5); // throws TypeError
- * ```
  */
 export declare const asInt32: <N extends number>(x: N) => number & {
     readonly NaNValue: false;
@@ -31,56 +27,43 @@ export declare const asInt32: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 32-bit signed integers.
- *
- * All operations automatically clamp results to the valid Int32 range [-2147483648, 2147483647].
- * This ensures that all arithmetic maintains the 32-bit signed integer constraint, preventing overflow.
- *
- * @example
- * ```typescript
- * const a = asInt32(2000000000);
- * const b = asInt32(500000000);
- *
- * // Arithmetic operations with automatic clamping
- * const sum = Int32.add(a, b);      // Int32 (2147483647 - clamped to MAX_VALUE)
- * const diff = Int32.sub(a, b);     // Int32 (1500000000)
- * const product = Int32.mul(a, b);  // Int32 (2147483647 - clamped due to overflow)
- *
- * // Range operations
- * const clamped = Int32.clamp(5000000000);    // Int32 (2147483647)
- * const minimum = Int32.min(a, b);            // Int32 (500000000)
- * const maximum = Int32.max(a, b);            // Int32 (2000000000)
+ * Namespace providing type-safe arithmetic operations for 32-bit signed
+ * integers.
  *
- * // Utility operations
- * const absolute = Int32.abs(asInt32(-1000)); // Int32 (1000)
- * const random = Int32.random();              // Int32 (random value in valid range)
- * ```
+ * All operations automatically clamp results to the valid Int32 range
+ * [-2147483648, 2147483647]. This ensures that all arithmetic maintains the
+ * 32-bit signed integer constraint, preventing overflow.
  */
 export declare const Int32: {
     /**
      * Type guard to check if a value is an Int32.
+     *
      * @param value The value to check.
      * @returns `true` if the value is a 32-bit signed integer, `false` otherwise.
      */
     readonly is: (a: number) => a is Int32;
     /**
      * The minimum value for a 32-bit signed integer.
+     *
      * @readonly
      */
     readonly MIN_VALUE: number;
     /**
      * The maximum value for a 32-bit signed integer.
+     *
      * @readonly
      */
     readonly MAX_VALUE: number;
     /**
      * Returns the absolute value of a 32-bit signed integer.
+     *
      * @param a The Int32 value.
      * @returns The absolute value as an Int32, clamped to valid range.
      */
     readonly abs: (x: WithSmallInt<Int32, 40>) => TsDataForgeInternals.RefinedNumberUtils.ToNonNegative<Int32>;
     /**
      * Returns the smaller of two Int32 values.
+     *
      * @param a The first Int32.
      * @param b The second Int32.
      * @returns The minimum value as an Int32.
@@ -88,6 +71,7 @@ export declare const Int32: {
     readonly min: (...values: readonly WithSmallInt<Int32, 40>[]) => Int32;
     /**
      * Returns the larger of two Int32 values.
+     *
      * @param a The first Int32.
      * @param b The second Int32.
      * @returns The maximum value as an Int32.
@@ -95,17 +79,20 @@ export declare const Int32: {
     readonly max: (...values: readonly WithSmallInt<Int32, 40>[]) => Int32;
     /**
      * Clamps a number to the Int32 range.
+     *
      * @param value The number to clamp.
      * @returns The value clamped to [-2147483648, 2147483647] as an Int32.
      */
     readonly clamp: (x: number) => Int32;
     /**
      * Generates a random Int32 value within the valid range.
+     *
      * @returns A random Int32 between MIN_VALUE and MAX_VALUE.
      */
     readonly random: (min?: WithSmallInt<Int32, 40> | undefined, max?: WithSmallInt<Int32, 40> | undefined) => Int32;
     /**
      * Raises an Int32 to the power of another Int32.
+     *
      * @param a The base Int32.
      * @param b The exponent Int32.
      * @returns `a ** b` clamped to [-2147483648, 2147483647] as an Int32.
@@ -113,6 +100,7 @@ export declare const Int32: {
     readonly pow: (x: WithSmallInt<Int32, 40>, y: WithSmallInt<Int32, 40>) => Int32;
     /**
      * Adds two Int32 values.
+     *
      * @param a The first Int32.
      * @param b The second Int32.
      * @returns `a + b` clamped to [-2147483648, 2147483647] as an Int32.
@@ -120,6 +108,7 @@ export declare const Int32: {
     readonly add: (x: WithSmallInt<Int32, 40>, y: WithSmallInt<Int32, 40>) => Int32;
     /**
      * Subtracts one Int32 from another.
+     *
      * @param a The minuend Int32.
      * @param b The subtrahend Int32.
      * @returns `a - b` clamped to [-2147483648, 2147483647] as an Int32.
@@ -127,6 +116,7 @@ export declare const Int32: {
     readonly sub: (x: WithSmallInt<Int32, 40>, y: WithSmallInt<Int32, 40>) => Int32;
     /**
      * Multiplies two Int32 values.
+     *
      * @param a The first Int32.
      * @param b The second Int32.
      * @returns `a * b` clamped to [-2147483648, 2147483647] as an Int32.
@@ -134,6 +124,7 @@ export declare const Int32: {
     readonly mul: (x: WithSmallInt<Int32, 40>, y: WithSmallInt<Int32, 40>) => Int32;
     /**
      * Divides one Int32 by another using floor division.
+     *
      * @param a The dividend Int32.
      * @param b The divisor Int32.
      * @returns `⌊a / b⌋` clamped to [-2147483648, 2147483647] as an Int32.

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

@@ -1 +1 @@
-{"version":3,"file":"int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int32.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAgCnE;;;;GAIG;AACH,eAAO,MAAM,OAAO,2BAAK,CAAC;AAE1B;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,KAAK;IAChB;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"int32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/int32.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAgCnE;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,2BAAK,CAAC;AAE1B;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;MAAW,CAAC;AAEhC;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;CAEK,CAAC"}

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

@@ -1,83 +1,66 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
 const typeNameInMessage = 'an integer in [-2^31, 2^31)';
-const { MIN_VALUE, MAX_VALUE, min: min_, max: max_, abs, pow, add, sub, mul, div, random, is, castType, clamp, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+const { MAX_VALUE, MIN_VALUE, abs, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
     integerOrSafeInteger: 'SafeInteger',
     MIN_VALUE: -2147483648,
     MAX_VALUE: 2 ** 31 - 1,
     typeNameInMessage,
 });
 /**
- * Checks if a number is an Int32 (32-bit signed integer in the range [-2^31, 2^31)).
+ * Checks if a number is an Int32 (32-bit signed integer in the range [-2^31,
+ * 2^31)).
+ *
  * @param value The value to check.
  * @returns `true` if the value is an Int32, `false` otherwise.
  */
 const isInt32 = is;
 /**
  * Casts a number to an Int32 type.
+ *
  * @param value The value to cast.
  * @returns The value as an Int32 type.
  * @throws {TypeError} If the value is not an integer in [-2^31, 2^31).
- * @example
- * ```typescript
- * const x = asInt32(100000); // Int32
- * const y = asInt32(-500000); // Int32
- * // asInt32(3000000000); // throws TypeError
- * // asInt32(1.5); // throws TypeError
- * ```
  */
 const asInt32 = castType;
 /**
- * Namespace providing type-safe arithmetic operations for 32-bit signed integers.
- *
- * All operations automatically clamp results to the valid Int32 range [-2147483648, 2147483647].
- * This ensures that all arithmetic maintains the 32-bit signed integer constraint, preventing overflow.
- *
- * @example
- * ```typescript
- * const a = asInt32(2000000000);
- * const b = asInt32(500000000);
- *
- * // Arithmetic operations with automatic clamping
- * const sum = Int32.add(a, b);      // Int32 (2147483647 - clamped to MAX_VALUE)
- * const diff = Int32.sub(a, b);     // Int32 (1500000000)
- * const product = Int32.mul(a, b);  // Int32 (2147483647 - clamped due to overflow)
- *
- * // Range operations
- * const clamped = Int32.clamp(5000000000);    // Int32 (2147483647)
- * const minimum = Int32.min(a, b);            // Int32 (500000000)
- * const maximum = Int32.max(a, b);            // Int32 (2000000000)
+ * Namespace providing type-safe arithmetic operations for 32-bit signed
+ * integers.
  *
- * // Utility operations
- * const absolute = Int32.abs(asInt32(-1000)); // Int32 (1000)
- * const random = Int32.random();              // Int32 (random value in valid range)
- * ```
+ * All operations automatically clamp results to the valid Int32 range
+ * [-2147483648, 2147483647]. This ensures that all arithmetic maintains the
+ * 32-bit signed integer constraint, preventing overflow.
  */
 const Int32 = {
     /**
      * Type guard to check if a value is an Int32.
+     *
      * @param value The value to check.
      * @returns `true` if the value is a 32-bit signed integer, `false` otherwise.
      */
     is,
     /**
      * The minimum value for a 32-bit signed integer.
+     *
      * @readonly
      */
     MIN_VALUE,
     /**
      * The maximum value for a 32-bit signed integer.
+     *
      * @readonly
      */
     MAX_VALUE,
     /**
      * Returns the absolute value of a 32-bit signed integer.
+     *
      * @param a The Int32 value.
      * @returns The absolute value as an Int32, clamped to valid range.
      */
     abs,
     /**
      * Returns the smaller of two Int32 values.
+     *
      * @param a The first Int32.
      * @param b The second Int32.
      * @returns The minimum value as an Int32.
@@ -85,6 +68,7 @@ const Int32 = {
     min: min_,
     /**
      * Returns the larger of two Int32 values.
+     *
      * @param a The first Int32.
      * @param b The second Int32.
      * @returns The maximum value as an Int32.
@@ -92,17 +76,20 @@ const Int32 = {
     max: max_,
     /**
      * Clamps a number to the Int32 range.
+     *
      * @param value The number to clamp.
      * @returns The value clamped to [-2147483648, 2147483647] as an Int32.
      */
     clamp,
     /**
      * Generates a random Int32 value within the valid range.
+     *
      * @returns A random Int32 between MIN_VALUE and MAX_VALUE.
      */
     random,
     /**
      * Raises an Int32 to the power of another Int32.
+     *
      * @param a The base Int32.
      * @param b The exponent Int32.
      * @returns `a ** b` clamped to [-2147483648, 2147483647] as an Int32.
@@ -110,6 +97,7 @@ const Int32 = {
     pow,
     /**
      * Adds two Int32 values.
+     *
      * @param a The first Int32.
      * @param b The second Int32.
      * @returns `a + b` clamped to [-2147483648, 2147483647] as an Int32.
@@ -117,6 +105,7 @@ const Int32 = {
     add,
     /**
      * Subtracts one Int32 from another.
+     *
      * @param a The minuend Int32.
      * @param b The subtrahend Int32.
      * @returns `a - b` clamped to [-2147483648, 2147483647] as an Int32.
@@ -124,6 +113,7 @@ const Int32 = {
     sub,
     /**
      * Multiplies two Int32 values.
+     *
      * @param a The first Int32.
      * @param b The second Int32.
      * @returns `a * b` clamped to [-2147483648, 2147483647] as an Int32.
@@ -131,6 +121,7 @@ const Int32 = {
     mul,
     /**
      * Divides one Int32 by another using floor division.
+     *
      * @param a The dividend Int32.
      * @param b The divisor Int32.
      * @returns `⌊a / b⌋` clamped to [-2147483648, 2147483647] as an Int32.

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

@@ -1 +1 @@
-{"version":3,"file":"int32.mjs","sources":["../../../src/number/branded-types/int32.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA,MAAM,iBAAiB,GAAG,6BAA6B;AAEvD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,MAAM,EACN,EAAE,EACF,QAAQ,EACR,KAAK,GACN,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,SAAS,EAAE,WAAU;AACrB,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;AAIG;AACI,MAAM,OAAO,GAAG;AAEvB;;;;;;;;;;;;AAYG;AACI,MAAM,OAAO,GAAG;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;AACI,MAAM,KAAK,GAAG;AACnB;;;;AAIG;IACH,EAAE;AAEF;;;AAGG;IACH,SAAS;AAET;;;AAGG;IACH,SAAS;AAET;;;;AAIG;IACH,GAAG;AAEH;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;AAIG;IACH,KAAK;AAEL;;;AAGG;IACH,MAAM;AAEN;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;AAEH;;;;;AAKG;IACH,GAAG;;;;;"}
+{"version":3,"file":"int32.mjs","sources":["../../../src/number/branded-types/int32.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAKA,MAAM,iBAAiB,GAAG,6BAA6B;AAEvD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,GAAG,EACH,QAAQ,EACR,KAAK,EACL,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,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,SAAS,EAAE,WAAU;AACrB,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;AAMG;AACI,MAAM,OAAO,GAAG;AAEvB;;;;;;AAMG;AACI,MAAM,OAAO,GAAG;AAEvB;;;;;;;AAOG;AACI,MAAM,KAAK,GAAG;AACnB;;;;;AAKG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;AAKG;IACH,GAAG;AAEH;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;;;;;"}

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

@@ -2,22 +2,17 @@ import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 type ElementType = NonNegativeFiniteNumber;
 /**
  * Checks if a number is a NonNegativeFiniteNumber (a finite number >= 0).
+ *
  * @param value The value to check.
  * @returns `true` if the value is a NonNegativeFiniteNumber, `false` otherwise.
  */
 export declare const isNonNegativeFiniteNumber: (a: number) => a is NonNegativeFiniteNumber;
 /**
  * Casts a number to a NonNegativeFiniteNumber type.
+ *
  * @param value The value to cast.
  * @returns The value as a NonNegativeFiniteNumber type.
  * @throws {TypeError} If the value is not a non-negative finite number.
- * @example
- * ```typescript
- * const x = asNonNegativeFiniteNumber(5.5); // NonNegativeFiniteNumber
- * const y = asNonNegativeFiniteNumber(0); // NonNegativeFiniteNumber
- * // asNonNegativeFiniteNumber(-1); // throws TypeError
- * // asNonNegativeFiniteNumber(Infinity); // throws TypeError
- * ```
  */
 export declare const asNonNegativeFiniteNumber: <N extends number>(x: N) => number & {
     readonly NaNValue: false;
@@ -31,48 +26,32 @@ export declare const asNonNegativeFiniteNumber: <N extends number>(x: N) => numb
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for non-negative finite numbers.
- *
- * All operations maintain the non-negative constraint by clamping negative results to 0,
- * while ensuring results remain finite (excluding NaN and Infinity). This type is useful
- * for representing measurements, distances, weights, and other inherently non-negative values.
- *
- * @example
- * ```typescript
- * const distance = asNonNegativeFiniteNumber(5.5);
- * const speed = asNonNegativeFiniteNumber(2.2);
- *
- * // Arithmetic operations with non-negative clamping
- * const total = NonNegativeFiniteNumber.add(distance, speed);        // NonNegativeFiniteNumber (7.7)
- * const diff = NonNegativeFiniteNumber.sub(speed, distance);        // NonNegativeFiniteNumber (0 - clamped)
- * const area = NonNegativeFiniteNumber.mul(distance, speed);        // NonNegativeFiniteNumber (12.1)
- * const ratio = NonNegativeFiniteNumber.div(distance, speed);       // NonNegativeFiniteNumber (2.5)
- *
- * // Range operations
- * const clamped = NonNegativeFiniteNumber.clamp(-10.5);             // NonNegativeFiniteNumber (0)
- * const minimum = NonNegativeFiniteNumber.min(distance, speed);     // NonNegativeFiniteNumber (2.2)
- * const maximum = NonNegativeFiniteNumber.max(distance, speed);     // NonNegativeFiniteNumber (5.5)
+ * Namespace providing type-safe arithmetic operations for non-negative finite
+ * numbers.
  *
- * // Rounding operations (return Uint)
- * const pixels = NonNegativeFiniteNumber.round(distance);           // Uint (6)
- * const floorValue = NonNegativeFiniteNumber.floor(distance);       // Uint (5)
- * const ceilValue = NonNegativeFiniteNumber.ceil(distance);         // Uint (6)
- * ```
+ * All operations maintain the non-negative constraint by clamping negative
+ * results to 0, while ensuring results remain finite (excluding NaN and
+ * Infinity). This type is useful for representing measurements, distances,
+ * weights, and other inherently non-negative values.
  */
 export declare const NonNegativeFiniteNumber: {
     /**
      * Type guard to check if a value is a NonNegativeFiniteNumber.
+     *
      * @param value The value to check.
-     * @returns `true` if the value is a non-negative finite number, `false` otherwise.
+     * @returns `true` if the value is a non-negative finite number, `false`
+     *   otherwise.
      */
     readonly is: (a: number) => a is NonNegativeFiniteNumber;
     /**
      * The minimum value for a non-negative finite number.
+     *
      * @readonly
      */
     readonly MIN_VALUE: 0;
     /**
      * Returns the smaller of two NonNegativeFiniteNumber values.
+     *
      * @param a The first NonNegativeFiniteNumber.
      * @param b The second NonNegativeFiniteNumber.
      * @returns The minimum value as a NonNegativeFiniteNumber.
@@ -80,6 +59,7 @@ export declare const NonNegativeFiniteNumber: {
     readonly min: (...values: readonly NonNegativeFiniteNumber[]) => NonNegativeFiniteNumber;
     /**
      * Returns the larger of two NonNegativeFiniteNumber values.
+     *
      * @param a The first NonNegativeFiniteNumber.
      * @param b The second NonNegativeFiniteNumber.
      * @returns The maximum value as a NonNegativeFiniteNumber.
@@ -87,35 +67,42 @@ export declare const NonNegativeFiniteNumber: {
     readonly max: (...values: readonly NonNegativeFiniteNumber[]) => NonNegativeFiniteNumber;
     /**
      * Clamps a number to the non-negative finite range.
+     *
      * @param value The number to clamp.
      * @returns The value clamped to [0, +∞) as a NonNegativeFiniteNumber.
      */
     readonly clamp: (x: number) => NonNegativeFiniteNumber;
     /**
      * Rounds down a NonNegativeFiniteNumber to the nearest integer.
+     *
      * @param x The NonNegativeFiniteNumber to round down.
      * @returns The floor value as a Uint.
      */
     readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
      * Rounds up a NonNegativeFiniteNumber to the nearest integer.
+     *
      * @param x The NonNegativeFiniteNumber to round up.
      * @returns The ceiling value as a Uint.
      */
     readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
      * Rounds a NonNegativeFiniteNumber to the nearest integer.
+     *
      * @param x The NonNegativeFiniteNumber to round.
      * @returns The rounded value as a Uint.
      */
     readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
      * Generates a random NonNegativeFiniteNumber value.
+     *
      * @returns A random non-negative finite number.
      */
     readonly random: (min?: NonNegativeFiniteNumber | undefined, max?: NonNegativeFiniteNumber | undefined) => NonNegativeFiniteNumber;
     /**
-     * Raises a NonNegativeFiniteNumber to the power of another NonNegativeFiniteNumber.
+     * Raises a NonNegativeFiniteNumber to the power of another
+     * NonNegativeFiniteNumber.
+     *
      * @param a The base NonNegativeFiniteNumber.
      * @param b The exponent NonNegativeFiniteNumber.
      * @returns `a ** b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
@@ -123,6 +110,7 @@ export declare const NonNegativeFiniteNumber: {
     readonly pow: (x: NonNegativeFiniteNumber, y: NonNegativeFiniteNumber) => NonNegativeFiniteNumber;
     /**
      * Adds two NonNegativeFiniteNumber values.
+     *
      * @param a The first NonNegativeFiniteNumber.
      * @param b The second NonNegativeFiniteNumber.
      * @returns `a + b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
@@ -130,13 +118,16 @@ export declare const NonNegativeFiniteNumber: {
     readonly add: (x: NonNegativeFiniteNumber, y: NonNegativeFiniteNumber) => NonNegativeFiniteNumber;
     /**
      * Subtracts one NonNegativeFiniteNumber from another.
+     *
      * @param a The minuend NonNegativeFiniteNumber.
      * @param b The subtrahend NonNegativeFiniteNumber.
-     * @returns `a - b` clamped to [0, +∞) as a NonNegativeFiniteNumber (minimum 0).
+     * @returns `a - b` clamped to [0, +∞) as a NonNegativeFiniteNumber (minimum
+     *   0).
      */
     readonly sub: (x: NonNegativeFiniteNumber, y: NonNegativeFiniteNumber) => NonNegativeFiniteNumber;
     /**
      * Multiplies two NonNegativeFiniteNumber values.
+     *
      * @param a The first NonNegativeFiniteNumber.
      * @param b The second NonNegativeFiniteNumber.
      * @returns `a * b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
@@ -144,6 +135,7 @@ export declare const NonNegativeFiniteNumber: {
     readonly mul: (x: NonNegativeFiniteNumber, y: NonNegativeFiniteNumber) => NonNegativeFiniteNumber;
     /**
      * Divides one NonNegativeFiniteNumber by another.
+     *
      * @param a The dividend NonNegativeFiniteNumber.
      * @param b The divisor NonNegativeFiniteNumber.
      * @returns `a / b` clamped to [0, +∞) as a NonNegativeFiniteNumber.

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

@@ -1 +1 @@
-{"version":3,"file":"non-negative-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,KAAK,WAAW,GAAG,uBAAuB,CAAC;AAiD3C;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,6CAAK,CAAC;AAE5C;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;wBAjHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAmH3D;;;;OAIG;uBAlHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAoH3D;;;;OAIG;wBAnHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAqH3D;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"non-negative-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,KAAK,WAAW,GAAG,uBAAuB,CAAC;AAiD3C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,6CAAK,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;wBA/FA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAiG3D;;;;;OAKG;uBAjGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAmG3D;;;;;OAKG;wBAnGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAqG3D;;;;OAIG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;CAEK,CAAC"}