ts-data-forge 11.0.0 → 12.0.0

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

@@ -1,19 +1,24 @@
 import { type SafeInt, type SafeUint, type NonZeroSafeInt as TtfImported_NonZeroSafeInt } from 'ts-type-forge';
 export type NonZeroSafeInt = TtfImported_NonZeroSafeInt;
 /**
- * Checks if a number is a NonZeroSafeInt (a non-zero safe integer in the range
- * [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] excluding 0).
+ * Type guard that checks if a value is a non-zero safe integer.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroSafeInt, `false` otherwise.
+ * Returns `true` for a non-zero safe integer — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero safe integer, `false` otherwise
  */
 export declare const isNonZeroSafeInt: (a: number) => a is TtfImported_NonZeroSafeInt;
 /**
- * Casts a number to a NonZeroSafeInt type.
+ * Casts a `number` to the `NonZeroSafeInt` branded type.
+ *
+ * Validates that the value is a non-zero safe integer and returns it with the
+ * `NonZeroSafeInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonZeroSafeInt type.
- * @throws {TypeError} If the value is not a non-zero safe integer.
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroSafeInt`
+ * @throws {TypeError} If the value is not a non-zero safe integer
  */
 export declare const asNonZeroSafeInt: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -25,92 +30,92 @@ export declare const asNonZeroSafeInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for non-zero safe
- * integers.
+ * Namespace providing type-safe operations for the `NonZeroSafeInt` branded
+ * type.
  *
- * All operations automatically clamp results to the non-zero safe integer
- * range, excluding zero. This ensures that all arithmetic maintains both the
- * non-zero constraint and IEEE 754 precision guarantees, preventing precision
- * loss while ensuring results are never zero.
+ * The `NonZeroSafeInt` type represents a non-zero safe integer. Division
+ * (`div`) uses floor division.
  */
 export declare const NonZeroSafeInt: {
     /**
-     * Type guard to check if a value is a NonZeroSafeInt.
+     * Type guard that checks if a value is a non-zero safe integer.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-zero safe integer, `false` otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-zero safe integer, `false` otherwise
+     * @see {@link isNonZeroSafeInt} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonZeroSafeInt;
     /**
-     * The minimum safe integer value (-(2^53 - 1)).
-     *
-     * @readonly
+     * The smallest value representable as `NonZeroSafeInt` (the lower saturation
+     * target of `fromNumber`).
      */
     readonly MIN_VALUE: SafeInt;
     /**
-     * The maximum safe integer value (2^53 - 1).
-     *
-     * @readonly
+     * The largest value representable as `NonZeroSafeInt` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: SafeUint;
     /**
      * Returns the absolute value of a non-zero safe integer.
      *
-     * @param a The NonZeroSafeInt value.
-     * @returns The absolute value as a NonZeroSafeInt, clamped to safe range.
+     * The result is non-negative and keeps the `NonZeroSafeInt` brand.
+     *
+     * @param a - The non-zero safe integer value
+     * @returns The absolute value as a non-negative `NonZeroSafeInt`
      */
     readonly abs: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt>) => import("ts-type-forge").IntersectBrand<TtfImported_NonZeroSafeInt, import("ts-type-forge").PositiveNumber>;
     /**
-     * Returns the smaller of two NonZeroSafeInt values.
+     * Returns the smallest of the given non-zero safe integers.
      *
-     * @param a The first NonZeroSafeInt.
-     * @param b The second NonZeroSafeInt.
-     * @returns The minimum value as a NonZeroSafeInt.
+     * @param values - The non-zero safe integers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroSafeInt`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt>[]) => TtfImported_NonZeroSafeInt;
     /**
-     * Returns the larger of two NonZeroSafeInt values.
+     * Returns the largest of the given non-zero safe integers.
      *
-     * @param a The first NonZeroSafeInt.
-     * @param b The second NonZeroSafeInt.
-     * @returns The maximum value as a NonZeroSafeInt.
+     * @param values - The non-zero safe integers to compare (at least one required)
+     * @returns The largest value as a `NonZeroSafeInt`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt>[]) => TtfImported_NonZeroSafeInt;
     /**
-     * Clamps a number to the non-zero safe integer range.
+     * Converts an arbitrary `number` into a `NonZeroSafeInt`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asNonZeroSafeInt`, this is total: out-of-range inputs are clamped
+     * to the nearest representable `NonZeroSafeInt` instead of throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] \ {0} as
-     *   a NonZeroSafeInt.
+     * @param value - The value to convert
+     * @returns The value as a `NonZeroSafeInt`
      */
-    readonly clamp: (x: number) => TtfImported_NonZeroSafeInt;
+    readonly fromNumber: (x: number) => TtfImported_NonZeroSafeInt;
     /**
-     * Generates a random NonZeroSafeInt value within the valid range.
+     * Generates a random `NonZeroSafeInt` within the given range.
      *
-     * @returns A random non-zero safe integer between MIN_SAFE_INTEGER and
-     *   MAX_SAFE_INTEGER.
+     * The range is inclusive on both ends.
+     *
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonZeroSafeInt` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt> | undefined) => TtfImported_NonZeroSafeInt;
     /**
-     * Raises a NonZeroSafeInt to the power of another NonZeroSafeInt.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroSafeInt`
+     * (floored to an integer).
      *
-     * @param a The base NonZeroSafeInt.
-     * @param b The exponent NonZeroSafeInt.
-     * @returns `a ** b` clamped to non-zero safe integer range as a
-     *   NonZeroSafeInt.
+     * @param a - The base non-zero safe integer
+     * @param b - The exponent non-zero safe integer
+     * @returns `a ** b` as a `NonZeroSafeInt`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt>) => TtfImported_NonZeroSafeInt;
     /**
-     * Multiplies two NonZeroSafeInt values.
-     *
-     * The product of two non-zero safe integers is always non-zero, so this stays
-     * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
-     * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+     * Multiplies two non-zero safe integers, returning `a * b` as a
+     * `NonZeroSafeInt`.
      *
-     * @param a The first NonZeroSafeInt.
-     * @param b The second NonZeroSafeInt.
-     * @returns `a * b` clamped to non-zero safe integer range as a
-     *   NonZeroSafeInt.
+     * @param a - The first non-zero safe integer
+     * @param b - The second non-zero safe integer
+     * @returns The product of `a` and `b` as a `NonZeroSafeInt`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroSafeInt>) => TtfImported_NonZeroSafeInt;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,KAAK,cAAc,IAAI,0BAA0B,EAClD,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAgCxD;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;MAAW,CAAC;AAEzC;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;;;;OAWG;;CAEK,CAAC"}
+{"version":3,"file":"non-zero-safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,KAAK,cAAc,IAAI,0BAA0B,EAClD,MAAM,eAAe,CAAC;AAIvB,MAAM,MAAM,cAAc,GAAG,0BAA0B,CAAC;AAgCxD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,gDAAK,CAAC;AAEnC;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;MAAW,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;;;OAOG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}

package/dist/number/branded-types/non-zero-safe-int.mjs

@@ -6,7 +6,7 @@ const {
   MIN_VALUE,
   abs,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -26,82 +26,84 @@ const isNonZeroSafeInt = is;
 const asNonZeroSafeInt = castType;
 const NonZeroSafeInt = {
   /**
-   * Type guard to check if a value is a NonZeroSafeInt.
+   * Type guard that checks if a value is a non-zero safe integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-zero safe integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-zero safe integer, `false` otherwise
+   * @see {@link isNonZeroSafeInt} for usage examples
    */
   is,
   /**
-   * The minimum safe integer value (-(2^53 - 1)).
-   *
-   * @readonly
+   * The smallest value representable as `NonZeroSafeInt` (the lower saturation
+   * target of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum safe integer value (2^53 - 1).
-   *
-   * @readonly
+   * The largest value representable as `NonZeroSafeInt` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
   /**
    * Returns the absolute value of a non-zero safe integer.
    *
-   * @param a The NonZeroSafeInt value.
-   * @returns The absolute value as a NonZeroSafeInt, clamped to safe range.
+   * The result is non-negative and keeps the `NonZeroSafeInt` brand.
+   *
+   * @param a - The non-zero safe integer value
+   * @returns The absolute value as a non-negative `NonZeroSafeInt`
    */
   abs,
   /**
-   * Returns the smaller of two NonZeroSafeInt values.
+   * Returns the smallest of the given non-zero safe integers.
    *
-   * @param a The first NonZeroSafeInt.
-   * @param b The second NonZeroSafeInt.
-   * @returns The minimum value as a NonZeroSafeInt.
+   * @param values - The non-zero safe integers to compare (at least one required)
+   * @returns The smallest value as a `NonZeroSafeInt`
    */
   min: min_,
   /**
-   * Returns the larger of two NonZeroSafeInt values.
+   * Returns the largest of the given non-zero safe integers.
    *
-   * @param a The first NonZeroSafeInt.
-   * @param b The second NonZeroSafeInt.
-   * @returns The maximum value as a NonZeroSafeInt.
+   * @param values - The non-zero safe integers to compare (at least one required)
+   * @returns The largest value as a `NonZeroSafeInt`
    */
   max: max_,
   /**
-   * Clamps a number to the non-zero safe integer range.
+   * Converts an arbitrary `number` into a `NonZeroSafeInt`, rounding to the
+   * nearest integer and saturating the result into the range `[MIN_VALUE,
+   * MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] \ {0} as
-   *   a NonZeroSafeInt.
+   * Unlike `asNonZeroSafeInt`, this is total: out-of-range inputs are clamped
+   * to the nearest representable `NonZeroSafeInt` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NonZeroSafeInt`
    */
-  clamp,
+  fromNumber,
   /**
-   * Generates a random NonZeroSafeInt value within the valid range.
+   * Generates a random `NonZeroSafeInt` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random non-zero safe integer between MIN_SAFE_INTEGER and
-   *   MAX_SAFE_INTEGER.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonZeroSafeInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a NonZeroSafeInt to the power of another NonZeroSafeInt.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroSafeInt`
+   * (floored to an integer).
    *
-   * @param a The base NonZeroSafeInt.
-   * @param b The exponent NonZeroSafeInt.
-   * @returns `a ** b` clamped to non-zero safe integer range as a
-   *   NonZeroSafeInt.
+   * @param a - The base non-zero safe integer
+   * @param b - The exponent non-zero safe integer
+   * @returns `a ** b` as a `NonZeroSafeInt`
    */
   pow,
   /**
-   * Multiplies two NonZeroSafeInt values.
-   *
-   * The product of two non-zero safe integers is always non-zero, so this stays
-   * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
-   * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+   * Multiplies two non-zero safe integers, returning `a * b` as a
+   * `NonZeroSafeInt`.
    *
-   * @param a The first NonZeroSafeInt.
-   * @param b The second NonZeroSafeInt.
-   * @returns `a * b` clamped to non-zero safe integer range as a
-   *   NonZeroSafeInt.
+   * @param a - The first non-zero safe integer
+   * @param b - The second non-zero safe integer
+   * @returns The product of `a` and `b` as a `NonZeroSafeInt`
    */
   mul
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-safe-int.mjs","sources":["../../../src/number/branded-types/non-zero-safe-int.mts"],"sourcesContent":["import {\n  type SafeInt,\n  type SafeUint,\n  type NonZeroSafeInt as TtfImported_NonZeroSafeInt,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroSafeInt = TtfImported_NonZeroSafeInt;\n\ntype ElementType = NonZeroSafeInt;\n\nconst typeNameInMessage = 'a non-zero safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  abs,\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  SafeInt,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer\n  MIN_VALUE: Number.MIN_SAFE_INTEGER as SafeInt,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a NonZeroSafeInt (a non-zero safe integer in the range\n * [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] excluding 0).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonZeroSafeInt, `false` otherwise.\n */\nexport const isNonZeroSafeInt = is;\n\n/**\n * Casts a number to a NonZeroSafeInt type.\n *\n * @param value The value to cast.\n * @returns The value as a NonZeroSafeInt type.\n * @throws {TypeError} If the value is not a non-zero safe integer.\n */\nexport const asNonZeroSafeInt = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for non-zero safe\n * integers.\n *\n * All operations automatically clamp results to the non-zero safe integer\n * range, excluding zero. This ensures that all arithmetic maintains both the\n * non-zero constraint and IEEE 754 precision guarantees, preventing precision\n * loss while ensuring results are never zero.\n */\nexport const NonZeroSafeInt = {\n  /**\n   * Type guard to check if a value is a NonZeroSafeInt.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-zero safe integer, `false` otherwise.\n   */\n  is,\n\n  /**\n   * The minimum safe integer value (-(2^53 - 1)).\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum safe integer value (2^53 - 1).\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a non-zero safe integer.\n   *\n   * @param a The NonZeroSafeInt value.\n   * @returns The absolute value as a NonZeroSafeInt, clamped to safe range.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two NonZeroSafeInt values.\n   *\n   * @param a The first NonZeroSafeInt.\n   * @param b The second NonZeroSafeInt.\n   * @returns The minimum value as a NonZeroSafeInt.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonZeroSafeInt values.\n   *\n   * @param a The first NonZeroSafeInt.\n   * @param b The second NonZeroSafeInt.\n   * @returns The maximum value as a NonZeroSafeInt.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the non-zero safe integer range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] \\ {0} as\n   *   a NonZeroSafeInt.\n   */\n  clamp,\n\n  /**\n   * Generates a random NonZeroSafeInt value within the valid range.\n   *\n   * @returns A random non-zero safe integer between MIN_SAFE_INTEGER and\n   *   MAX_SAFE_INTEGER.\n   */\n  random,\n\n  /**\n   * Raises a NonZeroSafeInt to the power of another NonZeroSafeInt.\n   *\n   * @param a The base NonZeroSafeInt.\n   * @param b The exponent NonZeroSafeInt.\n   * @returns `a ** b` clamped to non-zero safe integer range as a\n   *   NonZeroSafeInt.\n   */\n  pow,\n\n  /**\n   * Multiplies two NonZeroSafeInt values.\n   *\n   * The product of two non-zero safe integers is always non-zero, so this stays\n   * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may\n   * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.\n   *\n   * @param a The first NonZeroSafeInt.\n   * @param b The second NonZeroSafeInt.\n   * @returns `a * b` clamped to non-zero safe integer range as a\n   *   NonZeroSafeInt.\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroSafeInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range',\n    'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroSafeInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range',\n    'mul'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAYA,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,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA;AAAA,EAET,WAAW,MAAA,CAAO,gBAAA;AAAA;AAAA,EAElB,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AASH,MAAM,gBAAA,GAAmB;AASzB,MAAM,gBAAA,GAAmB;AAWzB,MAAM,cAAA,GAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO5B,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;AAAA,EAQA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA;AACF;;;;"}
+{"version":3,"file":"non-zero-safe-int.mjs","sources":["../../../src/number/branded-types/non-zero-safe-int.mts"],"sourcesContent":["import {\n  type SafeInt,\n  type SafeUint,\n  type NonZeroSafeInt as TtfImported_NonZeroSafeInt,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroSafeInt = TtfImported_NonZeroSafeInt;\n\ntype ElementType = NonZeroSafeInt;\n\nconst typeNameInMessage = 'a non-zero safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  abs,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  SafeInt,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer\n  MIN_VALUE: Number.MIN_SAFE_INTEGER as SafeInt,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-zero safe integer.\n *\n * Returns `true` for a non-zero safe integer — a value with no fractional\n * component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-zero safe integer, `false` otherwise\n */\nexport const isNonZeroSafeInt = is;\n\n/**\n * Casts a `number` to the `NonZeroSafeInt` branded type.\n *\n * Validates that the value is a non-zero safe integer and returns it with the\n * `NonZeroSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroSafeInt`\n * @throws {TypeError} If the value is not a non-zero safe integer\n */\nexport const asNonZeroSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroSafeInt` branded\n * type.\n *\n * The `NonZeroSafeInt` type represents a non-zero safe integer. Division\n * (`div`) uses floor division.\n */\nexport const NonZeroSafeInt = {\n  /**\n   * Type guard that checks if a value is a non-zero safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero safe integer, `false` otherwise\n   * @see {@link isNonZeroSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonZeroSafeInt` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonZeroSafeInt` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a non-zero safe integer.\n   *\n   * The result is non-negative and keeps the `NonZeroSafeInt` brand.\n   *\n   * @param a - The non-zero safe integer value\n   * @returns The absolute value as a non-negative `NonZeroSafeInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given non-zero safe integers.\n   *\n   * @param values - The non-zero safe integers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero safe integers.\n   *\n   * @param values - The non-zero safe integers to compare (at least one required)\n   * @returns The largest value as a `NonZeroSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonZeroSafeInt`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNonZeroSafeInt`, this is total: out-of-range inputs are clamped\n   * to the nearest representable `NonZeroSafeInt` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonZeroSafeInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NonZeroSafeInt` 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 `NonZeroSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroSafeInt`\n   * (floored to an integer).\n   *\n   * @param a - The base non-zero safe integer\n   * @param b - The exponent non-zero safe integer\n   * @returns `a ** b` as a `NonZeroSafeInt`\n   */\n  pow,\n\n  /**\n   * Multiplies two non-zero safe integers, returning `a * b` as a\n   * `NonZeroSafeInt`.\n   *\n   * @param a - The first non-zero safe integer\n   * @param b - The second non-zero safe integer\n   * @returns The product of `a` and `b` as a `NonZeroSafeInt`\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroSafeInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range',\n    'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroSafeInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range',\n    'mul'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,yBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;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;AAAA,EAET,WAAW,MAAA,CAAO,gBAAA;AAAA;AAAA,EAElB,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAWH,MAAM,gBAAA,GAAmB;AAYzB,MAAM,gBAAA,GAAmB;AASzB,MAAM,cAAA,GAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaL,UAAA;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;AAAA,EAUA;AACF;;;;"}

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

@@ -1,19 +1,24 @@
 import { type NonZeroUint16 as TtfImported_NonZeroUint16 } from 'ts-type-forge';
 export type NonZeroUint16 = TtfImported_NonZeroUint16;
 /**
- * Checks if a number is a NonZeroUint16 (16-bit non-zero unsigned integer in
- * the range [1, 2^16)).
+ * Type guard that checks if a value is a non-zero integer in [1, 2^16).
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroUint16, `false` otherwise.
+ * Returns `true` for a non-zero integer in [1, 2^16) — 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^16), `false` otherwise
  */
 export declare const isNonZeroUint16: (a: number) => a is import("ts-type-forge").PositiveUint16;
 /**
- * Casts a number to a NonZeroUint16 type.
+ * Casts a `number` to the `NonZeroUint16` branded type.
+ *
+ * Validates that the value is a non-zero integer in [1, 2^16) and returns it
+ * with the `NonZeroUint16` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonZeroUint16 type.
- * @throws {TypeError} If the value is not a non-zero integer in [1, 2^16).
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroUint16`
+ * @throws {TypeError} If the value is not a non-zero integer in [1, 2^16)
  */
 export declare const asNonZeroUint16: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -34,90 +39,90 @@ export declare const asNonZeroUint16: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 16-bit non-zero
- * unsigned integers.
+ * Namespace providing type-safe operations for the `NonZeroUint16` branded
+ * type.
  *
- * All operations automatically clamp results to the valid NonZeroUint16 range
- * [1, 65535]. This ensures that all arithmetic maintains the 16-bit non-zero
- * unsigned integer constraint, with results below 1 clamped to MIN_VALUE and
- * overflow results clamped to MAX_VALUE.
+ * The `NonZeroUint16` type represents a non-zero integer in [1, 2^16). Division
+ * (`div`) uses floor division.
  */
 export declare const NonZeroUint16: {
     /**
-     * Type guard to check if a value is a NonZeroUint16.
+     * Type guard that checks if a value is a non-zero integer in [1, 2^16).
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a 16-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^16), `false` otherwise
+     * @see {@link isNonZeroUint16} for usage examples
      */
     readonly is: (a: number) => a is import("ts-type-forge").PositiveUint16;
     /**
-     * The minimum value for a 16-bit non-zero unsigned integer.
-     *
-     * @readonly
+     * The smallest value representable as `NonZeroUint16` (the lower saturation
+     * target of `fromNumber`).
      */
     readonly MIN_VALUE: 1;
     /**
-     * The maximum value for a 16-bit non-zero unsigned integer.
-     *
-     * @readonly
+     * The largest value representable as `NonZeroUint16` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the smaller of two NonZeroUint16 values.
+     * Returns the smallest of the given non-zero integers.
      *
-     * @param a The first NonZeroUint16.
-     * @param b The second NonZeroUint16.
-     * @returns The minimum value as a NonZeroUint16.
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroUint16`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>[]) => import("ts-type-forge").PositiveUint16;
     /**
-     * Returns the larger of two NonZeroUint16 values.
+     * Returns the largest of the given non-zero integers.
      *
-     * @param a The first NonZeroUint16.
-     * @param b The second NonZeroUint16.
-     * @returns The maximum value as a NonZeroUint16.
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The largest value as a `NonZeroUint16`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>[]) => import("ts-type-forge").PositiveUint16;
     /**
-     * Clamps a number to the NonZeroUint16 range.
+     * Converts an arbitrary `number` into a `NonZeroUint16`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [1, 65535] as a NonZeroUint16.
+     * Unlike `asNonZeroUint16`, this is total: out-of-range inputs are clamped to
+     * the nearest representable `NonZeroUint16` instead of throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `NonZeroUint16`
      */
-    readonly clamp: (x: number) => import("ts-type-forge").PositiveUint16;
+    readonly fromNumber: (x: number) => import("ts-type-forge").PositiveUint16;
     /**
-     * Generates a random NonZeroUint16 value within the valid range.
+     * Generates a random `NonZeroUint16` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random NonZeroUint16 between 1 and 65535.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonZeroUint16` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16> | undefined, max?: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16> | undefined) => import("ts-type-forge").PositiveUint16;
     /**
-     * Raises a NonZeroUint16 to the power of another NonZeroUint16.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint16`
+     * (floored to an integer).
      *
-     * @param a The base NonZeroUint16.
-     * @param b The exponent NonZeroUint16.
-     * @returns `a ** b` clamped to [1, 65535] as a NonZeroUint16.
+     * @param a - The base non-zero integer
+     * @param b - The exponent non-zero integer
+     * @returns `a ** b` as a `NonZeroUint16`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>) => import("ts-type-forge").PositiveUint16;
     /**
-     * Adds two NonZeroUint16 values.
+     * Adds two non-zero integers, returning `a + b` as a `NonZeroUint16`.
      *
-     * @param a The first NonZeroUint16.
-     * @param b The second NonZeroUint16.
-     * @returns `a + b` clamped to [1, 65535] as a NonZeroUint16.
+     * @param a - The first non-zero integer
+     * @param b - The second non-zero integer
+     * @returns The sum of `a` and `b` as a `NonZeroUint16`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>) => import("ts-type-forge").PositiveUint16;
     /**
-     * Multiplies two NonZeroUint16 values.
-     *
-     * Both `add` and `mul` stay within `[1, 65535]`. 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 `NonZeroUint16`.
      *
-     * @param a The first NonZeroUint16.
-     * @param b The second NonZeroUint16.
-     * @returns `a * b` clamped to [1, 65535] as a NonZeroUint16.
+     * @param a - The first non-zero integer
+     * @param b - The second non-zero integer
+     * @returns The product of `a` and `b` as a `NonZeroUint16`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>, y: import("ts-type-forge").WithSmallInt<import("ts-type-forge").PositiveUint16>) => import("ts-type-forge").PositiveUint16;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-uint16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint16.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-uint16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-uint16.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;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}