ts-data-forge 11.0.0 → 11.0.1

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-uint16.mjs","sources":["../../../src/number/branded-types/non-zero-uint16.mts"],"sourcesContent":["import { type NonZeroUint16 as TtfImported_NonZeroUint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroUint16 = TtfImported_NonZeroUint16;\n\ntype ElementType = NonZeroUint16;\n\nconst typeNameInMessage = 'a non-zero integer in [1, 2^16)';\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 ** 16 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a NonZeroUint16 (16-bit non-zero unsigned integer in\n * the range [1, 2^16)).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonZeroUint16, `false` otherwise.\n */\nexport const isNonZeroUint16 = is;\n\n/**\n * Casts a number to a NonZeroUint16 type.\n *\n * @param value The value to cast.\n * @returns The value as a NonZeroUint16 type.\n * @throws {TypeError} If the value is not a non-zero integer in [1, 2^16).\n */\nexport const asNonZeroUint16 = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for 16-bit non-zero\n * unsigned integers.\n *\n * All operations automatically clamp results to the valid NonZeroUint16 range\n * [1, 65535]. This ensures that all arithmetic maintains the 16-bit non-zero\n * unsigned integer constraint, with results below 1 clamped to MIN_VALUE and\n * overflow results clamped to MAX_VALUE.\n */\nexport const NonZeroUint16 = {\n  /**\n   * Type guard to check if a value is a NonZeroUint16.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a 16-bit non-zero unsigned integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a 16-bit non-zero unsigned integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a 16-bit non-zero unsigned integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two NonZeroUint16 values.\n   *\n   * @param a The first NonZeroUint16.\n   * @param b The second NonZeroUint16.\n   * @returns The minimum value as a NonZeroUint16.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonZeroUint16 values.\n   *\n   * @param a The first NonZeroUint16.\n   * @param b The second NonZeroUint16.\n   * @returns The maximum value as a NonZeroUint16.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the NonZeroUint16 range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [1, 65535] as a NonZeroUint16.\n   */\n  clamp,\n\n  /**\n   * Generates a random NonZeroUint16 value within the valid range.\n   *\n   * @returns A random NonZeroUint16 between 1 and 65535.\n   */\n  random,\n\n  /**\n   * Raises a NonZeroUint16 to the power of another NonZeroUint16.\n   *\n   * @param a The base NonZeroUint16.\n   * @param b The exponent NonZeroUint16.\n   * @returns `a ** b` clamped to [1, 65535] as a NonZeroUint16.\n   */\n  pow,\n\n  /**\n   * Adds two NonZeroUint16 values.\n   *\n   * @param a The first NonZeroUint16.\n   * @param b The second NonZeroUint16.\n   * @returns `a + b` clamped to [1, 65535] as a NonZeroUint16.\n   */\n  add,\n\n  /**\n   * Multiplies two NonZeroUint16 values.\n   *\n   * Both `add` and `mul` stay within `[1, 65535]`. 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 NonZeroUint16.\n   * @param b The second NonZeroUint16.\n   * @returns `a * b` clamped to [1, 65535] as a NonZeroUint16.\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroUint16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroUint16,\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;;;;"}
+{"version":3,"file":"non-zero-uint16.mjs","sources":["../../../src/number/branded-types/non-zero-uint16.mts"],"sourcesContent":["import { type NonZeroUint16 as TtfImported_NonZeroUint16 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroUint16 = TtfImported_NonZeroUint16;\n\ntype ElementType = NonZeroUint16;\n\nconst typeNameInMessage = 'a non-zero integer in [1, 2^16)';\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 ** 16 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-zero integer in [1, 2^16).\n *\n * Returns `true` for a non-zero integer in [1, 2^16) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-zero integer in [1, 2^16), `false` otherwise\n */\nexport const isNonZeroUint16 = is;\n\n/**\n * Casts a `number` to the `NonZeroUint16` branded type.\n *\n * Validates that the value is a non-zero integer in [1, 2^16) and returns it\n * with the `NonZeroUint16` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroUint16`\n * @throws {TypeError} If the value is not a non-zero integer in [1, 2^16)\n */\nexport const asNonZeroUint16 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroUint16` branded\n * type.\n *\n * The `NonZeroUint16` type represents a non-zero integer in [1, 2^16). Division\n * (`div`) uses floor division.\n */\nexport const NonZeroUint16 = {\n  /**\n   * Type guard that checks if a value is a non-zero integer in [1, 2^16).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero integer in [1, 2^16), `false` otherwise\n   * @see {@link isNonZeroUint16} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonZeroUint16`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonZeroUint16`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroUint16`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The largest value as a `NonZeroUint16`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonZeroUint16` range, rounding to the nearest\n   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NonZeroUint16`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NonZeroUint16` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonZeroUint16` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint16`\n   * (floored to an integer).\n   *\n   * @param a - The base non-zero integer\n   * @param b - The exponent non-zero integer\n   * @returns `a ** b` as a `NonZeroUint16`\n   */\n  pow,\n\n  /**\n   * Adds two non-zero integers, returning `a + b` as a `NonZeroUint16`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The sum of `a` and `b` as a `NonZeroUint16`\n   */\n  add,\n\n  /**\n   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint16`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The product of `a` and `b` as a `NonZeroUint16`\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroUint16,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'positive' | 'range',\n    'add' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroUint16,\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;AAWH,MAAM,eAAA,GAAkB;AAYxB,MAAM,eAAA,GAAkB;AASxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,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,EASA;AACF;;;;"}

package/dist/number/branded-types/non-zero-uint32.d.mts

@@ -1,19 +1,24 @@
 import { type NonZeroUint32 as TtfImported_NonZeroUint32 } from 'ts-type-forge';
 export type NonZeroUint32 = TtfImported_NonZeroUint32;
 /**
- * Checks if a number is a NonZeroUint32 (32-bit non-zero unsigned integer in
- * the range [1, 2^32)).
+ * Type guard that checks if a value is a non-zero integer in [1, 2^32).
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroUint32, `false` otherwise.
+ * Returns `true` for a non-zero integer in [1, 2^32) — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise
  */
 export declare const isNonZeroUint32: (a: number) => a is import("ts-type-forge").PositiveUint32;
 /**
- * Casts a number to a NonZeroUint32 type.
+ * Casts a `number` to the `NonZeroUint32` branded type.
+ *
+ * Validates that the value is a non-zero integer in [1, 2^32) and returns it
+ * with the `NonZeroUint32` brand. Throws a `TypeError` otherwise.
  *
- * @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).
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroUint32`
+ * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32)
  */
 export declare const asNonZeroUint32: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -32,90 +37,84 @@ export declare const asNonZeroUint32: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 32-bit non-zero
- * unsigned integers.
+ * Namespace providing type-safe operations for the `NonZeroUint32` branded
+ * type.
  *
- * 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.
+ * The `NonZeroUint32` type represents a non-zero integer in [1, 2^32). Division
+ * (`div`) uses floor division.
  */
 export declare const NonZeroUint32: {
     /**
-     * Type guard to check if a value is a NonZeroUint32.
+     * Type guard that checks if a value is a non-zero integer in [1, 2^32).
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a 32-bit non-zero unsigned integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise
+     * @see {@link isNonZeroUint32} for usage examples
      */
     readonly is: (a: number) => a is import("ts-type-forge").PositiveUint32;
     /**
-     * The minimum value for a 32-bit non-zero unsigned integer.
-     *
-     * @readonly
+     * The smallest value representable as `NonZeroUint32`.
      */
     readonly MIN_VALUE: 1;
     /**
-     * The maximum value for a 32-bit non-zero unsigned integer.
-     *
-     * @readonly
+     * The largest value representable as `NonZeroUint32`.
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the smaller of two NonZeroUint32 values.
+     * Returns the smallest of the given non-zero integers.
      *
-     * @param a The first NonZeroUint32.
-     * @param b The second NonZeroUint32.
-     * @returns The minimum value as a NonZeroUint32.
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroUint32`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>[]) => import("ts-type-forge").PositiveUint32;
     /**
-     * Returns the larger of two NonZeroUint32 values.
+     * Returns the largest of the given non-zero integers.
      *
-     * @param a The first NonZeroUint32.
-     * @param b The second NonZeroUint32.
-     * @returns The maximum value as a NonZeroUint32.
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The largest value as a `NonZeroUint32`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>[]) => import("ts-type-forge").PositiveUint32;
     /**
-     * Clamps a number to the NonZeroUint32 range.
+     * Clamps a `number` into the `NonZeroUint32` range, rounding to the nearest
+     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [1, 4294967295] as a NonZeroUint32.
+     * @param value - The value to clamp
+     * @returns The clamped value as a `NonZeroUint32`
      */
     readonly clamp: (x: number) => import("ts-type-forge").PositiveUint32;
     /**
-     * Generates a random NonZeroUint32 value within the valid range.
+     * Generates a random `NonZeroUint32` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random NonZeroUint32 between 1 and 4294967295.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonZeroUint32` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32> | undefined, max?: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32> | undefined) => import("ts-type-forge").PositiveUint32;
     /**
-     * Raises a NonZeroUint32 to the power of another NonZeroUint32.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint32`
+     * (floored to an integer).
      *
-     * @param a The base NonZeroUint32.
-     * @param b The exponent NonZeroUint32.
-     * @returns `a ** b` clamped to [1, 4294967295] as a NonZeroUint32.
+     * @param a - The base non-zero integer
+     * @param b - The exponent non-zero integer
+     * @returns `a ** b` as a `NonZeroUint32`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>) => import("ts-type-forge").PositiveUint32;
     /**
-     * Adds two NonZeroUint32 values.
+     * Adds two non-zero integers, returning `a + b` as a `NonZeroUint32`.
      *
-     * @param a The first NonZeroUint32.
-     * @param b The second NonZeroUint32.
-     * @returns `a + b` clamped to [1, 4294967295] as a NonZeroUint32.
+     * @param a - The first non-zero integer
+     * @param b - The second non-zero integer
+     * @returns The sum of `a` and `b` as a `NonZeroUint32`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>) => import("ts-type-forge").PositiveUint32;
     /**
-     * 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}.
+     * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint32`.
      *
-     * @param a The first NonZeroUint32.
-     * @param b The second NonZeroUint32.
-     * @returns `a * b` clamped to [1, 4294967295] as a NonZeroUint32.
+     * @param a - The first non-zero integer
+     * @param b - The second non-zero integer
+     * @returns The product of `a` and `b` as a `NonZeroUint32`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint32>) => import("ts-type-forge").PositiveUint32;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA8BtD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,4DAAK,CAAC;AAElC;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;;OAUG;;CAEK,CAAC"}
+{"version":3,"file":"non-zero-uint32.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint32.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,IAAI,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAIhF,MAAM,MAAM,aAAa,GAAG,yBAAyB,CAAC;AA8BtD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,4DAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;MAAW,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;IACxB;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}

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

@@ -24,80 +24,76 @@ const isNonZeroUint32 = is;
 const asNonZeroUint32 = castType;
 const NonZeroUint32 = {
   /**
-   * Type guard to check if a value is a NonZeroUint32.
+   * Type guard that checks if a value is a non-zero integer in [1, 2^32).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 32-bit non-zero unsigned integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise
+   * @see {@link isNonZeroUint32} for usage examples
    */
   is,
   /**
-   * The minimum value for a 32-bit non-zero unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `NonZeroUint32`.
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 32-bit non-zero unsigned integer.
-   *
-   * @readonly
+   * The largest value representable as `NonZeroUint32`.
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two NonZeroUint32 values.
+   * Returns the smallest of the given non-zero integers.
    *
-   * @param a The first NonZeroUint32.
-   * @param b The second NonZeroUint32.
-   * @returns The minimum value as a NonZeroUint32.
+   * @param values - The non-zero integers to compare (at least one required)
+   * @returns The smallest value as a `NonZeroUint32`
    */
   min: min_,
   /**
-   * Returns the larger of two NonZeroUint32 values.
+   * Returns the largest of the given non-zero integers.
    *
-   * @param a The first NonZeroUint32.
-   * @param b The second NonZeroUint32.
-   * @returns The maximum value as a NonZeroUint32.
+   * @param values - The non-zero integers to compare (at least one required)
+   * @returns The largest value as a `NonZeroUint32`
    */
   max: max_,
   /**
-   * Clamps a number to the NonZeroUint32 range.
+   * Clamps a `number` into the `NonZeroUint32` range, rounding to the nearest
+   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [1, 4294967295] as a NonZeroUint32.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NonZeroUint32`
    */
   clamp,
   /**
-   * Generates a random NonZeroUint32 value within the valid range.
+   * Generates a random `NonZeroUint32` within the given range.
    *
-   * @returns A random NonZeroUint32 between 1 and 4294967295.
+   * The range is inclusive on both ends.
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonZeroUint32` in `[min, max]`
    */
   random,
   /**
-   * Raises a NonZeroUint32 to the power of another NonZeroUint32.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint32`
+   * (floored to an integer).
    *
-   * @param a The base NonZeroUint32.
-   * @param b The exponent NonZeroUint32.
-   * @returns `a ** b` clamped to [1, 4294967295] as a NonZeroUint32.
+   * @param a - The base non-zero integer
+   * @param b - The exponent non-zero integer
+   * @returns `a ** b` as a `NonZeroUint32`
    */
   pow,
   /**
-   * Adds two NonZeroUint32 values.
+   * Adds two non-zero integers, returning `a + b` as a `NonZeroUint32`.
    *
-   * @param a The first NonZeroUint32.
-   * @param b The second NonZeroUint32.
-   * @returns `a + b` clamped to [1, 4294967295] as a NonZeroUint32.
+   * @param a - The first non-zero integer
+   * @param b - The second non-zero integer
+   * @returns The sum of `a` and `b` 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}.
+   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint32`.
    *
-   * @param a The first NonZeroUint32.
-   * @param b The second NonZeroUint32.
-   * @returns `a * b` clamped to [1, 4294967295] as a NonZeroUint32.
+   * @param a - The first non-zero integer
+   * @param b - The second non-zero integer
+   * @returns The product of `a` and `b` as a `NonZeroUint32`
    */
   mul
 };

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":["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;;;;"}
+{"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 * Type guard that checks if a value is a non-zero integer in [1, 2^32).\n *\n * Returns `true` for a non-zero integer in [1, 2^32) — a value with no\n * fractional component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise\n */\nexport const isNonZeroUint32 = is;\n\n/**\n * Casts a `number` to the `NonZeroUint32` branded type.\n *\n * Validates that the value is a non-zero integer in [1, 2^32) and returns it\n * with the `NonZeroUint32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroUint32`\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 operations for the `NonZeroUint32` branded\n * type.\n *\n * The `NonZeroUint32` type represents a non-zero integer in [1, 2^32). Division\n * (`div`) uses floor division.\n */\nexport const NonZeroUint32 = {\n  /**\n   * Type guard that checks if a value is a non-zero integer in [1, 2^32).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise\n   * @see {@link isNonZeroUint32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonZeroUint32`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonZeroUint32`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroUint32`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The largest value as a `NonZeroUint32`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NonZeroUint32` range, rounding to the nearest\n   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NonZeroUint32`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NonZeroUint32` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `NonZeroUint32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint32`\n   * (floored to an integer).\n   *\n   * @param a - The base non-zero integer\n   * @param b - The exponent non-zero integer\n   * @returns `a ** b` as a `NonZeroUint32`\n   */\n  pow,\n\n  /**\n   * Adds two non-zero integers, returning `a + b` as a `NonZeroUint32`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The sum of `a` and `b` as a `NonZeroUint32`\n   */\n  add,\n\n  /**\n   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint32`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The product of `a` and `b` 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;AAWH,MAAM,eAAA,GAAkB;AAYxB,MAAM,eAAA,GAAkB;AASxB,MAAM,aAAA,GAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ3B,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,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,EASA;AACF;;;;"}

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

@@ -3,18 +3,24 @@ import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 export type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;
 type ElementType = PositiveFiniteNumber;
 /**
- * Checks if a number is a PositiveFiniteNumber (a finite number > 0).
+ * Type guard that checks if a value is a positive finite number.
  *
- * @param value The value to check.
- * @returns `true` if the value is a PositiveFiniteNumber, `false` otherwise.
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a positive finite number, `false` otherwise
  */
 export declare const isPositiveFiniteNumber: (a: number) => a is TtfImported_PositiveFiniteNumber;
 /**
- * Casts a number to a PositiveFiniteNumber type.
+ * Casts a `number` to the `PositiveFiniteNumber` branded type.
+ *
+ * Validates that the value is a positive finite number and returns it with the
+ * `PositiveFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a PositiveFiniteNumber type.
- * @throws {TypeError} If the value is not a positive finite number.
+ * @param value - The value to cast
+ * @returns The value as a `PositiveFiniteNumber`
+ * @throws {TypeError} If the value is not a positive finite number
  */
 export declare const asPositiveFiniteNumber: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -30,118 +36,123 @@ export declare const asPositiveFiniteNumber: <N extends number>(x: N) => number
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for positive finite
- * numbers.
+ * Namespace providing type-safe operations for the `PositiveFiniteNumber`
+ * branded type.
  *
- * 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.
+ * The `PositiveFiniteNumber` type represents a positive finite number.
  */
 export declare const PositiveFiniteNumber: {
     /**
-     * Type guard to check if a value is a PositiveFiniteNumber.
+     * Type guard that checks if a value is a positive finite number.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a positive finite number, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a positive finite number, `false` otherwise
+     * @see {@link isPositiveFiniteNumber} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_PositiveFiniteNumber;
     /**
-     * The minimum value for a positive finite number.
-     *
-     * @readonly
+     * The smallest value representable as `PositiveFiniteNumber`.
      */
     readonly MIN_VALUE: number;
     /**
-     * Returns the smaller of two PositiveFiniteNumber values.
+     * Returns the smallest of the given positive finite numbers.
      *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns The minimum value as a PositiveFiniteNumber.
+     * @param values - The positive finite numbers to compare (at least one required)
+     * @returns The smallest value as a `PositiveFiniteNumber`
      */
     readonly min: (...values: readonly TtfImported_PositiveFiniteNumber[]) => TtfImported_PositiveFiniteNumber;
     /**
-     * Returns the larger of two PositiveFiniteNumber values.
+     * Returns the largest of the given positive finite numbers.
      *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns The maximum value as a PositiveFiniteNumber.
+     * @param values - The positive finite numbers to compare (at least one required)
+     * @returns The largest value as a `PositiveFiniteNumber`
      */
     readonly max: (...values: readonly TtfImported_PositiveFiniteNumber[]) => TtfImported_PositiveFiniteNumber;
     /**
-     * Clamps a number to the positive finite range.
+     * Clamps a `number` into the `PositiveFiniteNumber` range `[MIN_VALUE,
+     * MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param value - The value to clamp
+     * @returns The clamped value as a `PositiveFiniteNumber`
      */
     readonly clamp: (x: number) => TtfImported_PositiveFiniteNumber;
     /**
-     * Rounds down a PositiveFiniteNumber to the nearest integer.
+     * Returns the greatest integer less than or equal to a positive finite
+     * number.
      *
-     * @param x The PositiveFiniteNumber to round down.
-     * @returns The floor value as a Uint (can be 0).
+     * @param a - The positive finite number value
+     * @returns The floored value as an integer
      */
     readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * Rounds up a PositiveFiniteNumber to the nearest integer.
+     * Returns the smallest integer greater than or equal to a positive finite
+     * number.
      *
-     * @param x The PositiveFiniteNumber to round up.
-     * @returns The ceiling value as a PositiveInt (always >= 1).
+     * @param a - The positive finite number value
+     * @returns The ceiled value as an integer
      */
     readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Rounds a PositiveFiniteNumber to the nearest integer.
+     * Returns the value of a positive finite number rounded to the nearest
+     * integer.
      *
-     * @param x The PositiveFiniteNumber to round.
-     * @returns The rounded value as a Uint (can be 0 if x < 0.5).
+     * @param a - The positive finite number value
+     * @returns The rounded value as an integer
      */
     readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>>;
     /**
-     * Generates a random PositiveFiniteNumber value.
+     * Generates a random `PositiveFiniteNumber` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random positive finite number.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `PositiveFiniteNumber` in `[min, max]`
      */
     readonly random: (min?: TtfImported_PositiveFiniteNumber | undefined, max?: TtfImported_PositiveFiniteNumber | undefined) => TtfImported_PositiveFiniteNumber;
     /**
-     * Raises a PositiveFiniteNumber to the power of another PositiveFiniteNumber.
+     * Raises `a` to the power `b`, returning `a ** b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The base PositiveFiniteNumber.
-     * @param b The exponent PositiveFiniteNumber.
-     * @returns `a ** b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param a - The base positive finite number
+     * @param b - The exponent positive finite number
+     * @returns `a ** b` as a `PositiveFiniteNumber`
      */
     readonly pow: (x: TtfImported_PositiveFiniteNumber, y: TtfImported_PositiveFiniteNumber) => TtfImported_PositiveFiniteNumber;
     /**
-     * Adds two PositiveFiniteNumber values.
+     * Adds two positive finite numbers, returning `a + b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns `a + b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param a - The first positive finite number
+     * @param b - The second positive finite number
+     * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`
      */
     readonly add: (x: TtfImported_PositiveFiniteNumber, y: TtfImported_PositiveFiniteNumber) => TtfImported_PositiveFiniteNumber;
     /**
-     * Subtracts one PositiveFiniteNumber from another.
+     * Subtracts two positive finite numbers, returning `a - b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The minuend PositiveFiniteNumber.
-     * @param b The subtrahend PositiveFiniteNumber.
-     * @returns `a - b` clamped to (0, +∞) as a PositiveFiniteNumber (minimum
-     *   MIN_VALUE).
+     * @param a - The first positive finite number
+     * @param b - The second positive finite number
+     * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`
      */
     readonly sub: (x: TtfImported_PositiveFiniteNumber, y: TtfImported_PositiveFiniteNumber) => TtfImported_PositiveFiniteNumber;
     /**
-     * Multiplies two PositiveFiniteNumber values.
+     * Multiplies two positive finite numbers, returning `a * b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The first PositiveFiniteNumber.
-     * @param b The second PositiveFiniteNumber.
-     * @returns `a * b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param a - The first positive finite number
+     * @param b - The second positive finite number
+     * @returns The product of `a` and `b` as a `PositiveFiniteNumber`
      */
     readonly mul: (x: TtfImported_PositiveFiniteNumber, y: TtfImported_PositiveFiniteNumber) => TtfImported_PositiveFiniteNumber;
     /**
-     * Divides one PositiveFiniteNumber by another.
+     * Divides two positive finite numbers, returning `a / b` as a
+     * `PositiveFiniteNumber`.
      *
-     * @param a The dividend PositiveFiniteNumber.
-     * @param b The divisor PositiveFiniteNumber.
-     * @returns `a / b` clamped to (0, +∞) as a PositiveFiniteNumber.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns `a / b` as a `PositiveFiniteNumber`
      */
     readonly div: (x: TtfImported_PositiveFiniteNumber, y: number & {
         readonly "!=0": true;

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

@@ -1 +1 @@
-{"version":3,"file":"positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oBAAoB,IAAI,gCAAgC,EAE9D,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AAEpE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAqExC;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,sDAAK,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;wBAnHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAmHC;;;;;OAKG;uBA/GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAiH3D;;;;;OAKG;wBAjHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAiHC;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"positive-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oBAAoB,IAAI,gCAAgC,EAE9D,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAC;AAEpE,KAAK,WAAW,GAAG,oBAAoB,CAAC;AAqExC;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,sDAAK,CAAC;AAEzC;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;MAAW,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;wBApHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAoHC;;;;;;OAMG;uBAjHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAmH3D;;;;;;OAMG;wBApHA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,qBAAqB,CAC9D,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC,CAC3D;IAoHC;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;CAEK,CAAC"}