ts-data-forge 9.0.0 → 10.0.0

package/dist/number/branded-types/negative-safe-int.mjs

@@ -1,135 +1,114 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 import { PositiveSafeInt } from './positive-safe-int.mjs';
 
-const typeNameInMessage = 'a negative safe integer';
-const { MAX_VALUE, MIN_VALUE, add, castType, clamp, is, max: max_, min: min_, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'SafeInteger',
-    nonZero: true,
-    MIN_VALUE: Number.MIN_SAFE_INTEGER,
-    MAX_VALUE: -1,
-    typeNameInMessage,
+const typeNameInMessage = "a negative safe integer";
+const {
+  MAX_VALUE,
+  MIN_VALUE,
+  add,
+  castType,
+  clamp,
+  is,
+  max: max_,
+  min: min_,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "SafeInteger",
+  nonZero: true,
+  MIN_VALUE: Number.MIN_SAFE_INTEGER,
+  MAX_VALUE: -1,
+  typeNameInMessage
 });
-/**
- * Returns the absolute value of a negative safe integer.
- *
- * The absolute value of a negative safe integer is always a positive safe
- * integer (`>= 1`), so the result is typed as a {@link PositiveSafeInt}.
- *
- * @param x - The negative safe integer.
- * @returns `|x|` as a PositiveSafeInt.
- */
 const abs = (x) => PositiveSafeInt.clamp(Math.abs(x));
-/**
- * Checks if a number is a NegativeSafeInt (a negative safe integer in the range
- * `[Number.MIN_SAFE_INTEGER, -1]`).
- *
- * @param value The value to check.
- * @returns `true` if the value is a NegativeSafeInt, `false` otherwise.
- */
 const isNegativeSafeInt = is;
-/**
- * Casts a number to a NegativeSafeInt type.
- *
- * @param value The value to cast.
- * @returns The value as a NegativeSafeInt type.
- * @throws {TypeError} If the value is not a negative safe integer.
- */
 const asNegativeSafeInt = castType;
-/**
- * Namespace providing type-safe arithmetic operations for negative safe
- * integers.
- *
- * NegativeSafeInt represents safe integers that are strictly less than zero
- * (`[Number.MIN_SAFE_INTEGER, -1]`). Operations that stay within the negative
- * safe integers clamp their results to the valid range, while operations whose
- * result leaves the set (`mul`, `div`, `abs`) are typed to reflect the actual
- * sign of the result.
- */
 const NegativeSafeInt = {
-    /**
-     * Type guard to check if a value is a NegativeSafeInt.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a negative safe integer, `false` otherwise.
-     */
-    is,
-    /**
-     * The minimum value for a negative safe integer.
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * The maximum value for a negative safe integer.
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the absolute value of a negative safe integer.
-     *
-     * @param a The negative safe integer.
-     * @returns The absolute value as a PositiveSafeInt.
-     */
-    abs,
-    /**
-     * Returns the smaller of two negative safe integers.
-     *
-     * @param a The first negative safe integer.
-     * @param b The second negative safe integer.
-     * @returns The minimum value as a NegativeSafeInt.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two negative safe integers.
-     *
-     * @param a The first negative safe integer.
-     * @param b The second negative safe integer.
-     * @returns The maximum value as a NegativeSafeInt.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the NegativeSafeInt range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to `[Number.MIN_SAFE_INTEGER, -1]` as a
-     *   NegativeSafeInt.
-     */
-    clamp,
-    /**
-     * Generates a random NegativeSafeInt value within the valid range.
-     *
-     * @returns A random NegativeSafeInt between Number.MIN_SAFE_INTEGER and -1.
-     */
-    random,
-    /**
-     * Raises a negative safe integer to the power of another negative safe
-     * integer.
-     *
-     * @param a The base negative safe integer.
-     * @param b The exponent negative safe integer.
-     * @returns `a ** b` clamped to the NegativeSafeInt range.
-     */
-    pow,
-    /**
-     * Adds two negative safe integers.
-     *
-     * @param a The first negative safe integer.
-     * @param b The second negative safe integer.
-     * @returns `a + b` clamped to the NegativeSafeInt range.
-     */
-    add,
-    /**
-     * Subtracts one negative safe integer from another.
-     *
-     * The mathematical result can be positive, so it is clamped to the
-     * NegativeSafeInt range (maximum `-1`).
-     *
-     * @param a The minuend negative safe integer.
-     * @param b The subtrahend negative safe integer.
-     * @returns `a - b` clamped to the NegativeSafeInt range.
-     */
-    sub,
+  /**
+   * Type guard to check if a value is a NegativeSafeInt.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a negative safe integer, `false` otherwise.
+   */
+  is,
+  /**
+   * The minimum value for a negative safe integer.
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * The maximum value for a negative safe integer.
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the absolute value of a negative safe integer.
+   *
+   * @param a The negative safe integer.
+   * @returns The absolute value as a PositiveSafeInt.
+   */
+  abs,
+  /**
+   * Returns the smaller of two negative safe integers.
+   *
+   * @param a The first negative safe integer.
+   * @param b The second negative safe integer.
+   * @returns The minimum value as a NegativeSafeInt.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two negative safe integers.
+   *
+   * @param a The first negative safe integer.
+   * @param b The second negative safe integer.
+   * @returns The maximum value as a NegativeSafeInt.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the NegativeSafeInt range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to `[Number.MIN_SAFE_INTEGER, -1]` as a
+   *   NegativeSafeInt.
+   */
+  clamp,
+  /**
+   * Generates a random NegativeSafeInt value within the valid range.
+   *
+   * @returns A random NegativeSafeInt between Number.MIN_SAFE_INTEGER and -1.
+   */
+  random,
+  /**
+   * Raises a negative safe integer to the power of another negative safe
+   * integer.
+   *
+   * @param a The base negative safe integer.
+   * @param b The exponent negative safe integer.
+   * @returns `a ** b` clamped to the NegativeSafeInt range.
+   */
+  pow,
+  /**
+   * Adds two negative safe integers.
+   *
+   * @param a The first negative safe integer.
+   * @param b The second negative safe integer.
+   * @returns `a + b` clamped to the NegativeSafeInt range.
+   */
+  add,
+  /**
+   * Subtracts one negative safe integer from another.
+   *
+   * The mathematical result can be positive, so it is clamped to the
+   * NegativeSafeInt range (maximum `-1`).
+   *
+   * @param a The minuend negative safe integer.
+   * @param b The subtrahend negative safe integer.
+   * @returns `a - b` clamped to the NegativeSafeInt range.
+   */
+  sub
 };
 
 export { NegativeSafeInt, asNegativeSafeInt, isNegativeSafeInt };

package/dist/number/branded-types/negative-safe-int.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"negative-safe-int.mjs","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAWA,MAAM,iBAAiB,GAAG,yBAAyB;AAEnD,MAAM,EACJ,SAAS,EACT,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,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,MAAM,CAAC,gBAAgB;IAClC,SAAS,EAAE,EAAE;IACb,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;;;AAQG;AACH,MAAM,GAAG,GAAG,CAAC,CAA4B,KACvC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEpC;;;;;;AAMG;AACI,MAAM,iBAAiB,GAAG;AAEjC;;;;;;AAMG;AACI,MAAM,iBAAiB,GAAG;AAEjC;;;;;;;;;AASG;AACI,MAAM,eAAe,GAAG;AAC7B;;;;;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;;;;;;AAMG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;;AAOG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;;;;AASG;IACH,GAAG;;;;;"}
+{"version":3,"file":"negative-safe-int.mjs","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"sourcesContent":["import {\n  type NegativeSafeInt as TtfImported_NegativeSafeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveSafeInt } from './positive-safe-int.mjs';\n\nexport type NegativeSafeInt = TtfImported_NegativeSafeInt;\n\ntype ElementType = NegativeSafeInt;\n\nconst typeNameInMessage = 'a negative safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  -1\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Returns the absolute value of a negative safe integer.\n *\n * The absolute value of a negative safe integer is always a positive safe\n * integer (`>= 1`), so the result is typed as a {@link PositiveSafeInt}.\n *\n * @param x - The negative safe integer.\n * @returns `|x|` as a PositiveSafeInt.\n */\nconst abs = (x: WithSmallInt<ElementType>): PositiveSafeInt =>\n  PositiveSafeInt.clamp(Math.abs(x));\n\n/**\n * Checks if a number is a NegativeSafeInt (a negative safe integer in the range\n * `[Number.MIN_SAFE_INTEGER, -1]`).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NegativeSafeInt, `false` otherwise.\n */\nexport const isNegativeSafeInt = is;\n\n/**\n * Casts a number to a NegativeSafeInt type.\n *\n * @param value The value to cast.\n * @returns The value as a NegativeSafeInt type.\n * @throws {TypeError} If the value is not a negative safe integer.\n */\nexport const asNegativeSafeInt = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for negative safe\n * integers.\n *\n * NegativeSafeInt represents safe integers that are strictly less than zero\n * (`[Number.MIN_SAFE_INTEGER, -1]`). Operations that stay within the negative\n * safe integers clamp their results to the valid range, while operations whose\n * result leaves the set (`mul`, `div`, `abs`) are typed to reflect the actual\n * sign of the result.\n */\nexport const NegativeSafeInt = {\n  /**\n   * Type guard to check if a value is a NegativeSafeInt.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a negative safe integer, `false` otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a negative safe integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a negative safe integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative safe integer.\n   *\n   * @param a The negative safe integer.\n   * @returns The absolute value as a PositiveSafeInt.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two negative safe integers.\n   *\n   * @param a The first negative safe integer.\n   * @param b The second negative safe integer.\n   * @returns The minimum value as a NegativeSafeInt.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two negative safe integers.\n   *\n   * @param a The first negative safe integer.\n   * @param b The second negative safe integer.\n   * @returns The maximum value as a NegativeSafeInt.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the NegativeSafeInt range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to `[Number.MIN_SAFE_INTEGER, -1]` as a\n   *   NegativeSafeInt.\n   */\n  clamp,\n\n  /**\n   * Generates a random NegativeSafeInt value within the valid range.\n   *\n   * @returns A random NegativeSafeInt between Number.MIN_SAFE_INTEGER and -1.\n   */\n  random,\n\n  /**\n   * Raises a negative safe integer to the power of another negative safe\n   * integer.\n   *\n   * @param a The base negative safe integer.\n   * @param b The exponent negative safe integer.\n   * @returns `a ** b` clamped to the NegativeSafeInt range.\n   */\n  pow,\n\n  /**\n   * Adds two negative safe integers.\n   *\n   * @param a The first negative safe integer.\n   * @param b The second negative safe integer.\n   * @returns `a + b` clamped to the NegativeSafeInt range.\n   */\n  add,\n\n  /**\n   * Subtracts one negative safe integer from another.\n   *\n   * The mathematical result can be positive, so it is clamped to the\n   * NegativeSafeInt range (maximum `-1`).\n   *\n   * @param a The minuend negative safe integer.\n   * @param b The subtrahend negative safe integer.\n   * @returns `a - b` clamped to the NegativeSafeInt range.\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,MAAM,iBAAA,GAAoB,yBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,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,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAWV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,eAAA,CAAgB,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAS5B,MAAM,iBAAA,GAAoB;AAS1B,MAAM,iBAAA,GAAoB;AAY1B,MAAM,eAAA,GAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO7B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA;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;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA;AACF;;;;"}

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

@@ -17,13 +17,13 @@ export declare const isNonNegativeFiniteNumber: (a: number) => a is TtfImported_
  * @throws {TypeError} If the value is not a non-negative finite number.
  */
 export declare const asNonNegativeFiniteNumber: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
-    readonly Finite: true;
     readonly "> -2^16": true;
     readonly "> -2^32": true;
     readonly ">= -2^15": true;
     readonly ">= -2^31": true;
     readonly ">=0": true;
+    readonly Finite: true;
+    readonly NaNValue: false;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
@@ -143,14 +143,14 @@ export declare const NonNegativeFiniteNumber: {
      * @returns `a / b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
      */
     readonly div: (x: TtfImported_NonNegativeFiniteNumber, y: number & {
-        readonly NaNValue: false;
-        readonly Finite: true;
+        readonly "!=0": true;
         readonly "> -2^16": true;
         readonly "> -2^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
-        readonly "!=0": true;
+        readonly Finite: true;
+        readonly NaNValue: false;
     } & Readonly<{
         'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
     }>) => TtfImported_NonNegativeFiniteNumber;

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

@@ -1,151 +1,145 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a non-negative finite number';
-const { MIN_VALUE, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
-    MIN_VALUE: 0,
-    MAX_VALUE: Number.MAX_VALUE,
-    typeNameInMessage,
+const typeNameInMessage = "a non-negative finite number";
+const {
+  MIN_VALUE,
+  add,
+  castType,
+  clamp,
+  div,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+  MIN_VALUE: 0,
+  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);
-/**
- * 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.
- */
+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 isNonNegativeFiniteNumber = is;
-/**
- * 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.
- */
 const asNonNegativeFiniteNumber = castType;
-/**
- * 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.
- */
 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.
-     */
-    is,
-    /**
-     * The minimum value for a non-negative finite number.
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * Returns the smaller of two NonNegativeFiniteNumber values.
-     *
-     * @param a The first NonNegativeFiniteNumber.
-     * @param b The second NonNegativeFiniteNumber.
-     * @returns The minimum value as a NonNegativeFiniteNumber.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two NonNegativeFiniteNumber values.
-     *
-     * @param a The first NonNegativeFiniteNumber.
-     * @param b The second NonNegativeFiniteNumber.
-     * @returns The maximum value as a NonNegativeFiniteNumber.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the non-negative finite range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, +∞) as a NonNegativeFiniteNumber.
-     */
-    clamp,
-    /**
-     * Rounds down a NonNegativeFiniteNumber to the nearest integer.
-     *
-     * @param x The NonNegativeFiniteNumber to round down.
-     * @returns The floor value as a Uint.
-     */
-    floor,
-    /**
-     * Rounds up a NonNegativeFiniteNumber to the nearest integer.
-     *
-     * @param x The NonNegativeFiniteNumber to round up.
-     * @returns The ceiling value as a Uint.
-     */
-    ceil,
-    /**
-     * Rounds a NonNegativeFiniteNumber to the nearest integer.
-     *
-     * @param x The NonNegativeFiniteNumber to round.
-     * @returns The rounded value as a Uint.
-     */
-    round,
-    /**
-     * Generates a random NonNegativeFiniteNumber value.
-     *
-     * @returns A random non-negative finite number.
-     */
-    random,
-    /**
-     * 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.
-     */
-    pow,
-    /**
-     * Adds two NonNegativeFiniteNumber values.
-     *
-     * @param a The first NonNegativeFiniteNumber.
-     * @param b The second NonNegativeFiniteNumber.
-     * @returns `a + b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
-     */
-    add,
-    /**
-     * 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).
-     */
-    sub,
-    /**
-     * Multiplies two NonNegativeFiniteNumber values.
-     *
-     * @param a The first NonNegativeFiniteNumber.
-     * @param b The second NonNegativeFiniteNumber.
-     * @returns `a * b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
-     */
-    mul,
-    /**
-     * Divides one NonNegativeFiniteNumber by another.
-     *
-     * @param a The dividend NonNegativeFiniteNumber.
-     * @param b The divisor NonNegativeFiniteNumber.
-     * @returns `a / b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
-     */
-    div,
+  /**
+   * 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.
+   */
+  is,
+  /**
+   * The minimum value for a non-negative finite number.
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * Returns the smaller of two NonNegativeFiniteNumber values.
+   *
+   * @param a The first NonNegativeFiniteNumber.
+   * @param b The second NonNegativeFiniteNumber.
+   * @returns The minimum value as a NonNegativeFiniteNumber.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two NonNegativeFiniteNumber values.
+   *
+   * @param a The first NonNegativeFiniteNumber.
+   * @param b The second NonNegativeFiniteNumber.
+   * @returns The maximum value as a NonNegativeFiniteNumber.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the non-negative finite range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   */
+  clamp,
+  /**
+   * Rounds down a NonNegativeFiniteNumber to the nearest integer.
+   *
+   * @param x The NonNegativeFiniteNumber to round down.
+   * @returns The floor value as a Uint.
+   */
+  floor,
+  /**
+   * Rounds up a NonNegativeFiniteNumber to the nearest integer.
+   *
+   * @param x The NonNegativeFiniteNumber to round up.
+   * @returns The ceiling value as a Uint.
+   */
+  ceil,
+  /**
+   * Rounds a NonNegativeFiniteNumber to the nearest integer.
+   *
+   * @param x The NonNegativeFiniteNumber to round.
+   * @returns The rounded value as a Uint.
+   */
+  round,
+  /**
+   * Generates a random NonNegativeFiniteNumber value.
+   *
+   * @returns A random non-negative finite number.
+   */
+  random,
+  /**
+   * 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.
+   */
+  pow,
+  /**
+   * Adds two NonNegativeFiniteNumber values.
+   *
+   * @param a The first NonNegativeFiniteNumber.
+   * @param b The second NonNegativeFiniteNumber.
+   * @returns `a + b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   */
+  add,
+  /**
+   * 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).
+   */
+  sub,
+  /**
+   * Multiplies two NonNegativeFiniteNumber values.
+   *
+   * @param a The first NonNegativeFiniteNumber.
+   * @param b The second NonNegativeFiniteNumber.
+   * @returns `a * b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   */
+  mul,
+  /**
+   * Divides one NonNegativeFiniteNumber by another.
+   *
+   * @param a The dividend NonNegativeFiniteNumber.
+   * @param b The divisor NonNegativeFiniteNumber.
+   * @returns `a / b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   */
+  div
 };
 
 export { NonNegativeFiniteNumber, asNonNegativeFiniteNumber, isNonNegativeFiniteNumber };

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

@@ -1 +1 @@
-{"version":3,"file":"non-negative-finite-number.mjs","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAWA,MAAM,iBAAiB,GAAG,8BAA8B;AAExD,MAAM,EACJ,SAAS,EACT,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,iBAAiB,CAI3D;AACA,IAAA,SAAS,EAAE,CAAC;IACZ,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;;;;;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;;;;;;;AAOG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;;AAOG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;;;;;"}
+{"version":3,"file":"non-negative-finite-number.mjs","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"sourcesContent":["import {\n  type NonNegativeFiniteNumber as TtfImported_NonNegativeFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeFiniteNumber = TtfImported_NonNegativeFiniteNumber;\n\ntype ElementType = NonNegativeFiniteNumber;\n\nconst typeNameInMessage = 'a non-negative finite number';\n\nconst {\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\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  0,\n  number\n>({\n  MIN_VALUE: 0,\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>, Uint>(\n  '=',\n);\n\n/**\n * Checks if a number is a NonNegativeFiniteNumber (a finite number >= 0).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonNegativeFiniteNumber, `false` otherwise.\n */\nexport const isNonNegativeFiniteNumber = is;\n\n/**\n * Casts a number to a NonNegativeFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a NonNegativeFiniteNumber type.\n * @throws {TypeError} If the value is not a non-negative finite number.\n */\nexport const asNonNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for non-negative finite\n * numbers.\n *\n * All operations maintain the non-negative constraint by clamping negative\n * results to 0, while ensuring results remain finite (excluding NaN and\n * Infinity). This type is useful for representing measurements, distances,\n * weights, and other inherently non-negative values.\n */\nexport const NonNegativeFiniteNumber = {\n  /**\n   * Type guard to check if a value is a NonNegativeFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-negative finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a non-negative finite number.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smaller of two NonNegativeFiniteNumber values.\n   *\n   * @param a The first NonNegativeFiniteNumber.\n   * @param b The second NonNegativeFiniteNumber.\n   * @returns The minimum value as a NonNegativeFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonNegativeFiniteNumber values.\n   *\n   * @param a The first NonNegativeFiniteNumber.\n   * @param b The second NonNegativeFiniteNumber.\n   * @returns The maximum value as a NonNegativeFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the non-negative finite range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  clamp,\n\n  /**\n   * Rounds down a NonNegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NonNegativeFiniteNumber to round down.\n   * @returns The floor value as a Uint.\n   */\n  floor,\n\n  /**\n   * Rounds up a NonNegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NonNegativeFiniteNumber to round up.\n   * @returns The ceiling value as a Uint.\n   */\n  ceil,\n\n  /**\n   * Rounds a NonNegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NonNegativeFiniteNumber to round.\n   * @returns The rounded value as a Uint.\n   */\n  round,\n\n  /**\n   * Generates a random NonNegativeFiniteNumber value.\n   *\n   * @returns A random non-negative finite number.\n   */\n  random,\n\n  /**\n   * Raises a NonNegativeFiniteNumber to the power of another\n   * NonNegativeFiniteNumber.\n   *\n   * @param a The base NonNegativeFiniteNumber.\n   * @param b The exponent NonNegativeFiniteNumber.\n   * @returns `a ** b` clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Adds two NonNegativeFiniteNumber values.\n   *\n   * @param a The first NonNegativeFiniteNumber.\n   * @param b The second NonNegativeFiniteNumber.\n   * @returns `a + b` clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  add,\n\n  /**\n   * Subtracts one NonNegativeFiniteNumber from another.\n   *\n   * @param a The minuend NonNegativeFiniteNumber.\n   * @param b The subtrahend NonNegativeFiniteNumber.\n   * @returns `a - b` clamped to [0, +∞) as a NonNegativeFiniteNumber (minimum\n   *   0).\n   */\n  sub,\n\n  /**\n   * Multiplies two NonNegativeFiniteNumber values.\n   *\n   * @param a The first NonNegativeFiniteNumber.\n   * @param b The second NonNegativeFiniteNumber.\n   * @returns `a * b` clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  mul,\n\n  /**\n   * Divides one NonNegativeFiniteNumber by another.\n   *\n   * @param a The dividend NonNegativeFiniteNumber.\n   * @param b The divisor NonNegativeFiniteNumber.\n   * @returns `a / b` clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;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,CAAA;AAAA,EACX,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;AAYP,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;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}