ts-data-forge 8.0.0 → 9.0.1

package/dist/number/branded-types/non-zero-uint32.mjs

@@ -1,116 +1,105 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a non-zero integer in [1, 2^32)';
-const { MAX_VALUE, MIN_VALUE, add, castType, clamp, is, max: max_, min: min_, mul, pow, randomNonZero: random, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'SafeInteger',
-    nonZero: true,
-    MIN_VALUE: 1,
-    MAX_VALUE: 2 ** 32 - 1,
-    typeNameInMessage,
+const typeNameInMessage = "a non-zero integer in [1, 2^32)";
+const {
+  MAX_VALUE,
+  MIN_VALUE,
+  add,
+  castType,
+  clamp,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  randomNonZero: random
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "SafeInteger",
+  nonZero: true,
+  MIN_VALUE: 1,
+  MAX_VALUE: 2 ** 32 - 1,
+  typeNameInMessage
 });
-/**
- * Checks if a number is a NonZeroUint32 (32-bit non-zero unsigned integer in
- * the range [1, 2^32)).
- *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroUint32, `false` otherwise.
- */
 const isNonZeroUint32 = is;
-/**
- * Casts a number to a NonZeroUint32 type.
- *
- * @param value The value to cast.
- * @returns The value as a NonZeroUint32 type.
- * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32).
- */
 const asNonZeroUint32 = castType;
-/**
- * Namespace providing type-safe arithmetic operations for 32-bit non-zero
- * unsigned integers.
- *
- * All operations automatically clamp results to the valid NonZeroUint32 range
- * [1, 4294967295]. This ensures that all arithmetic maintains the 32-bit
- * non-zero unsigned integer constraint, with results below 1 clamped to
- * MIN_VALUE and overflow results clamped to MAX_VALUE.
- */
 const NonZeroUint32 = {
-    /**
-     * Type guard to check if a value is a NonZeroUint32.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a 32-bit non-zero unsigned integer, `false`
-     *   otherwise.
-     */
-    is,
-    /**
-     * The minimum value for a 32-bit non-zero unsigned integer.
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * The maximum value for a 32-bit non-zero unsigned integer.
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the smaller of two NonZeroUint32 values.
-     *
-     * @param a The first NonZeroUint32.
-     * @param b The second NonZeroUint32.
-     * @returns The minimum value as a NonZeroUint32.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two NonZeroUint32 values.
-     *
-     * @param a The first NonZeroUint32.
-     * @param b The second NonZeroUint32.
-     * @returns The maximum value as a NonZeroUint32.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the NonZeroUint32 range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to [1, 4294967295] as a NonZeroUint32.
-     */
-    clamp,
-    /**
-     * Generates a random NonZeroUint32 value within the valid range.
-     *
-     * @returns A random NonZeroUint32 between 1 and 4294967295.
-     */
-    random,
-    /**
-     * Raises a NonZeroUint32 to the power of another NonZeroUint32.
-     *
-     * @param a The base NonZeroUint32.
-     * @param b The exponent NonZeroUint32.
-     * @returns `a ** b` clamped to [1, 4294967295] as a NonZeroUint32.
-     */
-    pow,
-    /**
-     * Adds two NonZeroUint32 values.
-     *
-     * @param a The first NonZeroUint32.
-     * @param b The second NonZeroUint32.
-     * @returns `a + b` clamped to [1, 4294967295] as a NonZeroUint32.
-     */
-    add,
-    /**
-     * Multiplies two NonZeroUint32 values.
-     *
-     * Both `add` and `mul` stay within `[1, 4294967295]`. For the non-closed
-     * operations (`sub`/`div`, whose result may be `0`) use {@link Num.sub} /
-     * {@link Num.divInt}.
-     *
-     * @param a The first NonZeroUint32.
-     * @param b The second NonZeroUint32.
-     * @returns `a * b` clamped to [1, 4294967295] as a NonZeroUint32.
-     */
-    mul,
+  /**
+   * Type guard to check if a value is a NonZeroUint32.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a 32-bit non-zero unsigned integer, `false`
+   *   otherwise.
+   */
+  is,
+  /**
+   * The minimum value for a 32-bit non-zero unsigned integer.
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * The maximum value for a 32-bit non-zero unsigned integer.
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the smaller of two NonZeroUint32 values.
+   *
+   * @param a The first NonZeroUint32.
+   * @param b The second NonZeroUint32.
+   * @returns The minimum value as a NonZeroUint32.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two NonZeroUint32 values.
+   *
+   * @param a The first NonZeroUint32.
+   * @param b The second NonZeroUint32.
+   * @returns The maximum value as a NonZeroUint32.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the NonZeroUint32 range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to [1, 4294967295] as a NonZeroUint32.
+   */
+  clamp,
+  /**
+   * Generates a random NonZeroUint32 value within the valid range.
+   *
+   * @returns A random NonZeroUint32 between 1 and 4294967295.
+   */
+  random,
+  /**
+   * Raises a NonZeroUint32 to the power of another NonZeroUint32.
+   *
+   * @param a The base NonZeroUint32.
+   * @param b The exponent NonZeroUint32.
+   * @returns `a ** b` clamped to [1, 4294967295] as a NonZeroUint32.
+   */
+  pow,
+  /**
+   * Adds two NonZeroUint32 values.
+   *
+   * @param a The first NonZeroUint32.
+   * @param b The second NonZeroUint32.
+   * @returns `a + b` clamped to [1, 4294967295] as a NonZeroUint32.
+   */
+  add,
+  /**
+   * Multiplies two NonZeroUint32 values.
+   *
+   * Both `add` and `mul` stay within `[1, 4294967295]`. For the non-closed
+   * operations (`sub`/`div`, whose result may be `0`) use {@link Num.sub} /
+   * {@link Num.divInt}.
+   *
+   * @param a The first NonZeroUint32.
+   * @param b The second NonZeroUint32.
+   * @returns `a * b` clamped to [1, 4294967295] as a NonZeroUint32.
+   */
+  mul
 };
 
 export { NonZeroUint32, asNonZeroUint32, isNonZeroUint32 };

package/dist/number/branded-types/non-zero-uint32.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"non-zero-uint32.mjs","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAQA,MAAM,iBAAiB,GAAG,iCAAiC;AAE3D,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,aAAa,EAAE,MAAM,GACtB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,OAAO,EAAE,IAAI;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;AAMG;AACI,MAAM,eAAe,GAAG;AAE/B;;;;;;AAMG;AACI,MAAM,eAAe,GAAG;AAE/B;;;;;;;;AAQG;AACI,MAAM,aAAa,GAAG;AAC3B;;;;;;AAMG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;;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;;;;;;;;;;AAUG;IACH,GAAG;;;;;"}
+{"version":3,"file":"non-zero-uint32.mjs","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"sourcesContent":["import { type NonZeroUint32 as TtfImported_NonZeroUint32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroUint32 = TtfImported_NonZeroUint32;\n\ntype ElementType = NonZeroUint32;\n\nconst typeNameInMessage = 'a non-zero integer in [1, 2^32)';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  1,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\n  MIN_VALUE: 1,\n  MAX_VALUE: 2 ** 32 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a NonZeroUint32 (32-bit non-zero unsigned integer in\n * the range [1, 2^32)).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonZeroUint32, `false` otherwise.\n */\nexport const isNonZeroUint32 = is;\n\n/**\n * Casts a number to a NonZeroUint32 type.\n *\n * @param value The value to cast.\n * @returns The value as a NonZeroUint32 type.\n * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32).\n */\nexport const asNonZeroUint32 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 32-bit non-zero\n * unsigned integers.\n *\n * All operations automatically clamp results to the valid NonZeroUint32 range\n * [1, 4294967295]. This ensures that all arithmetic maintains the 32-bit\n * non-zero unsigned integer constraint, with results below 1 clamped to\n * MIN_VALUE and overflow results clamped to MAX_VALUE.\n */\nexport const NonZeroUint32 = {\n  /**\n   * Type guard to check if a value is a NonZeroUint32.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a 32-bit non-zero unsigned integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a 32-bit non-zero unsigned integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a 32-bit non-zero unsigned integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two NonZeroUint32 values.\n   *\n   * @param a The first NonZeroUint32.\n   * @param b The second NonZeroUint32.\n   * @returns The minimum value as a NonZeroUint32.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonZeroUint32 values.\n   *\n   * @param a The first NonZeroUint32.\n   * @param b The second NonZeroUint32.\n   * @returns The maximum value as a NonZeroUint32.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the NonZeroUint32 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [1, 4294967295] as a NonZeroUint32.\n   */\n  clamp,\n\n  /**\n   * Generates a random NonZeroUint32 value within the valid range.\n   *\n   * @returns A random NonZeroUint32 between 1 and 4294967295.\n   */\n  random,\n\n  /**\n   * Raises a NonZeroUint32 to the power of another NonZeroUint32.\n   *\n   * @param a The base NonZeroUint32.\n   * @param b The exponent NonZeroUint32.\n   * @returns `a ** b` clamped to [1, 4294967295] as a NonZeroUint32.\n   */\n  pow,\n\n  /**\n   * Adds two NonZeroUint32 values.\n   *\n   * @param a The first NonZeroUint32.\n   * @param b The second NonZeroUint32.\n   * @returns `a + b` clamped to [1, 4294967295] as a NonZeroUint32.\n   */\n  add,\n\n  /**\n   * Multiplies two NonZeroUint32 values.\n   *\n   * Both `add` and `mul` stay within `[1, 4294967295]`. For the non-closed\n   * operations (`sub`/`div`, whose result may be `0`) use {@link Num.sub} /\n   * {@link Num.divInt}.\n   *\n   * @param a The first NonZeroUint32.\n   * @param b The second NonZeroUint32.\n   * @returns `a * b` clamped to [1, 4294967295] as a NonZeroUint32.\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroUint32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroUint32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,iCAAA;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,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAA;AAAA,EACX,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AASH,MAAM,eAAA,GAAkB;AASxB,MAAM,eAAA,GAAkB;AAWxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;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,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA;AACF;;;;"}

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

@@ -17,15 +17,15 @@ export declare const isPositiveFiniteNumber: (a: number) => a is TtfImported_Pos
  * @throws {TypeError} If the value is not a positive finite number.
  */
 export declare const asPositiveFiniteNumber: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
-    readonly Finite: true;
+    readonly "!=0": true;
+    readonly "<=0": false;
     readonly "> -2^16": true;
     readonly "> -2^32": true;
     readonly ">= -2^15": true;
     readonly ">= -2^31": true;
     readonly ">=0": true;
-    readonly "!=0": true;
-    readonly "<=0": false;
+    readonly Finite: true;
+    readonly NaNValue: false;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
@@ -144,15 +144,15 @@ export declare const PositiveFiniteNumber: {
      * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
      */
     readonly div: (x: TtfImported_PositiveFiniteNumber, y: number & {
-        readonly NaNValue: false;
-        readonly Finite: true;
+        readonly "!=0": true;
+        readonly "<=0": false;
         readonly "> -2^16": true;
         readonly "> -2^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
-        readonly "!=0": true;
-        readonly "<=0": false;
+        readonly Finite: true;
+        readonly NaNValue: false;
     } & Readonly<{
         'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
     }>) => TtfImported_PositiveFiniteNumber;

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

@@ -1,150 +1,148 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a positive finite number';
-const { MIN_VALUE, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
-    MIN_VALUE: Number.MIN_VALUE,
-    MAX_VALUE: Number.MAX_VALUE,
-    typeNameInMessage,
+const typeNameInMessage = "a positive finite number";
+const {
+  MIN_VALUE,
+  add,
+  castType,
+  clamp,
+  div,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+  MIN_VALUE: Number.MIN_VALUE,
+  MAX_VALUE: Number.MAX_VALUE,
+  typeNameInMessage
 });
-const floor = (x) => 
-// eslint-disable-next-line total-functions/no-unsafe-type-assertion
-Math.floor(x);
-const ceil = (x) => 
-// eslint-disable-next-line total-functions/no-unsafe-type-assertion
-Math.ceil(x);
-const round = (x) => 
-// eslint-disable-next-line total-functions/no-unsafe-type-assertion
-Math.round(x);
-/**
- * Checks if a number is a PositiveFiniteNumber (a finite number > 0).
- *
- * @param value The value to check.
- * @returns `true` if the value is a PositiveFiniteNumber, `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 isPositiveFiniteNumber = is;
-/**
- * Casts a number to a PositiveFiniteNumber type.
- *
- * @param value The value to cast.
- * @returns The value as a PositiveFiniteNumber type.
- * @throws {TypeError} If the value is not a positive finite number.
- */
 const asPositiveFiniteNumber = castType;
-/**
- * Namespace providing type-safe arithmetic operations for positive finite
- * numbers.
- *
- * All operations maintain the positive constraint by clamping non-positive
- * results to MIN_VALUE, while ensuring results remain finite (excluding NaN and
- * Infinity). This type is useful for representing quantities that must always
- * be positive, such as probabilities, magnitudes, and physical measurements.
- */
 const PositiveFiniteNumber = {
-    /**
-     * Type guard to check if a value is a PositiveFiniteNumber.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a positive finite number, `false`
-     *   otherwise.
-     */
-    is,
-    /**
-     * The minimum value for a positive finite number.
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * Returns the smaller of two PositiveFiniteNumber values.
-     *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns The minimum value as a PositiveFiniteNumber.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two PositiveFiniteNumber values.
-     *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns The maximum value as a PositiveFiniteNumber.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the positive finite range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.
-     */
-    clamp,
-    /**
-     * Rounds down a PositiveFiniteNumber to the nearest integer.
-     *
-     * @param x The PositiveFiniteNumber to round down.
-     * @returns The floor value as a Uint (can be 0).
-     */
-    floor,
-    /**
-     * Rounds up a PositiveFiniteNumber to the nearest integer.
-     *
-     * @param x The PositiveFiniteNumber to round up.
-     * @returns The ceiling value as a PositiveInt (always >= 1).
-     */
-    ceil,
-    /**
-     * Rounds a PositiveFiniteNumber to the nearest integer.
-     *
-     * @param x The PositiveFiniteNumber to round.
-     * @returns The rounded value as a Uint (can be 0 if x < 0.5).
-     */
-    round,
-    /**
-     * Generates a random PositiveFiniteNumber value.
-     *
-     * @returns A random positive finite number.
-     */
-    random,
-    /**
-     * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.
-     *
-     * @param a The base PositiveFiniteNumber.
-     * @param b The exponent PositiveFiniteNumber.
-     * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.
-     */
-    pow,
-    /**
-     * Adds two PositiveFiniteNumber values.
-     *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.
-     */
-    add,
-    /**
-     * Subtracts one PositiveFiniteNumber from another.
-     *
-     * @param a The minuend PositiveFiniteNumber.
-     * @param b The subtrahend PositiveFiniteNumber.
-     * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum
-     *   MIN_VALUE).
-     */
-    sub,
-    /**
-     * Multiplies two PositiveFiniteNumber values.
-     *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.
-     */
-    mul,
-    /**
-     * Divides one PositiveFiniteNumber by another.
-     *
-     * @param a The dividend PositiveFiniteNumber.
-     * @param b The divisor PositiveFiniteNumber.
-     * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
-     */
-    div,
+  /**
+   * Type guard to check if a value is a PositiveFiniteNumber.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a positive finite number, `false`
+   *   otherwise.
+   */
+  is,
+  /**
+   * The minimum value for a positive finite number.
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * Returns the smaller of two PositiveFiniteNumber values.
+   *
+   * @param a The first PositiveFiniteNumber.
+   * @param b The second PositiveFiniteNumber.
+   * @returns The minimum value as a PositiveFiniteNumber.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two PositiveFiniteNumber values.
+   *
+   * @param a The first PositiveFiniteNumber.
+   * @param b The second PositiveFiniteNumber.
+   * @returns The maximum value as a PositiveFiniteNumber.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the positive finite range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.
+   */
+  clamp,
+  /**
+   * Rounds down a PositiveFiniteNumber to the nearest integer.
+   *
+   * @param x The PositiveFiniteNumber to round down.
+   * @returns The floor value as a Uint (can be 0).
+   */
+  floor,
+  /**
+   * Rounds up a PositiveFiniteNumber to the nearest integer.
+   *
+   * @param x The PositiveFiniteNumber to round up.
+   * @returns The ceiling value as a PositiveInt (always >= 1).
+   */
+  ceil,
+  /**
+   * Rounds a PositiveFiniteNumber to the nearest integer.
+   *
+   * @param x The PositiveFiniteNumber to round.
+   * @returns The rounded value as a Uint (can be 0 if x < 0.5).
+   */
+  round,
+  /**
+   * Generates a random PositiveFiniteNumber value.
+   *
+   * @returns A random positive finite number.
+   */
+  random,
+  /**
+   * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.
+   *
+   * @param a The base PositiveFiniteNumber.
+   * @param b The exponent PositiveFiniteNumber.
+   * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   */
+  pow,
+  /**
+   * Adds two PositiveFiniteNumber values.
+   *
+   * @param a The first PositiveFiniteNumber.
+   * @param b The second PositiveFiniteNumber.
+   * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   */
+  add,
+  /**
+   * Subtracts one PositiveFiniteNumber from another.
+   *
+   * @param a The minuend PositiveFiniteNumber.
+   * @param b The subtrahend PositiveFiniteNumber.
+   * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum
+   *   MIN_VALUE).
+   */
+  sub,
+  /**
+   * Multiplies two PositiveFiniteNumber values.
+   *
+   * @param a The first PositiveFiniteNumber.
+   * @param b The second PositiveFiniteNumber.
+   * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   */
+  mul,
+  /**
+   * Divides one PositiveFiniteNumber by another.
+   *
+   * @param a The dividend PositiveFiniteNumber.
+   * @param b The divisor PositiveFiniteNumber.
+   * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
+   */
+  div
 };
 
 export { PositiveFiniteNumber, asPositiveFiniteNumber, isPositiveFiniteNumber };

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

@@ -1 +1 @@
-{"version":3,"file":"positive-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAYA,MAAM,iBAAiB,GAAG,0BAA0B;AAEpD,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;IACA,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,iBAAiB;AACT,CAAA,CAAC;AAEX,MAAM,KAAK,GAAG,CACZ,CAAc;AAId;AACA,IAAI,CAAC,KAAK,CACR,CAAC,CAGF;AAEH,MAAM,IAAI,GAAG,CACX,CAAc;AAEd;AACA,IAAI,CAAC,IAAI,CAAC,CAAC,CAA+D;AAE5E,MAAM,KAAK,GAAG,CACZ,CAAc;AAId;AACA,IAAI,CAAC,KAAK,CACR,CAAC,CAGF;AAcH;;;;;AAKG;AACI,MAAM,sBAAsB,GAAG;AAEtC;;;;;;AAMG;AACI,MAAM,sBAAsB,GAAG;AAEtC;;;;;;;;AAQG;AACI,MAAM,oBAAoB,GAAG;AAClC;;;;;;AAMG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;;AAKG;IACH,KAAK;AAEL;;;;;AAKG;IACH,IAAI;AAEJ;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;;AAOG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;;;;;"}
+{"version":3,"file":"positive-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":["import {\n  type PositiveInt,\n  type PositiveFiniteNumber as TtfImported_PositiveFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;\n\ntype ElementType = PositiveFiniteNumber;\n\nconst typeNameInMessage = 'a positive 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  number,\n  number\n>({\n  MIN_VALUE: Number.MIN_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.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.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  PositiveInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Uint\n>('=');\n\n/**\n * Checks if a number is a PositiveFiniteNumber (a finite number > 0).\n *\n * @param value The value to check.\n * @returns `true` if the value is a PositiveFiniteNumber, `false` otherwise.\n */\nexport const isPositiveFiniteNumber = is;\n\n/**\n * Casts a number to a PositiveFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a PositiveFiniteNumber type.\n * @throws {TypeError} If the value is not a positive finite number.\n */\nexport const asPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for positive finite\n * numbers.\n *\n * All operations maintain the positive constraint by clamping non-positive\n * results to MIN_VALUE, while ensuring results remain finite (excluding NaN and\n * Infinity). This type is useful for representing quantities that must always\n * be positive, such as probabilities, magnitudes, and physical measurements.\n */\nexport const PositiveFiniteNumber = {\n  /**\n   * Type guard to check if a value is a PositiveFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a positive finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a positive finite number.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smaller of two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns The minimum value as a PositiveFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns The maximum value as a PositiveFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the positive finite range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  clamp,\n\n  /**\n   * Rounds down a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round down.\n   * @returns The floor value as a Uint (can be 0).\n   */\n  floor,\n\n  /**\n   * Rounds up a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round up.\n   * @returns The ceiling value as a PositiveInt (always >= 1).\n   */\n  ceil,\n\n  /**\n   * Rounds a PositiveFiniteNumber to the nearest integer.\n   *\n   * @param x The PositiveFiniteNumber to round.\n   * @returns The rounded value as a Uint (can be 0 if x < 0.5).\n   */\n  round,\n\n  /**\n   * Generates a random PositiveFiniteNumber value.\n   *\n   * @returns A random positive finite number.\n   */\n  random,\n\n  /**\n   * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.\n   *\n   * @param a The base PositiveFiniteNumber.\n   * @param b The exponent PositiveFiniteNumber.\n   * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Adds two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  add,\n\n  /**\n   * Subtracts one PositiveFiniteNumber from another.\n   *\n   * @param a The minuend PositiveFiniteNumber.\n   * @param b The subtrahend PositiveFiniteNumber.\n   * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum\n   *   MIN_VALUE).\n   */\n  sub,\n\n  /**\n   * Multiplies two PositiveFiniteNumber values.\n   *\n   * @param a The first PositiveFiniteNumber.\n   * @param b The second PositiveFiniteNumber.\n   * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  mul,\n\n  /**\n   * Divides one PositiveFiniteNumber by another.\n   *\n   * @param a The dividend PositiveFiniteNumber.\n   * @param b The divisor PositiveFiniteNumber.\n   * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'positive'>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,0BAAA;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,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAIF,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAsBK,MAAM,sBAAA,GAAyB;AAS/B,MAAM,sBAAA,GAAyB;AAW/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}

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

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