ts-data-forge 9.0.0 → 10.0.0

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

@@ -1,120 +1,109 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a non-zero safe integer';
-const { MAX_VALUE, MIN_VALUE, abs, castType, clamp, is, max: max_, min: min_, mul, pow, randomNonZero: random, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'SafeInteger',
-    nonZero: true,
-    // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer
-    MIN_VALUE: Number.MIN_SAFE_INTEGER,
-    // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer
-    MAX_VALUE: Number.MAX_SAFE_INTEGER,
-    typeNameInMessage,
+const typeNameInMessage = "a non-zero safe integer";
+const {
+  MAX_VALUE,
+  MIN_VALUE,
+  abs,
+  castType,
+  clamp,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  randomNonZero: random
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "SafeInteger",
+  nonZero: true,
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-min-safe-integer
+  MIN_VALUE: Number.MIN_SAFE_INTEGER,
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer
+  MAX_VALUE: Number.MAX_SAFE_INTEGER,
+  typeNameInMessage
 });
-/**
- * Checks if a number is a NonZeroSafeInt (a non-zero safe integer in the range
- * [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] excluding 0).
- *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroSafeInt, `false` otherwise.
- */
 const isNonZeroSafeInt = is;
-/**
- * Casts a number to a NonZeroSafeInt type.
- *
- * @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.
- */
 const asNonZeroSafeInt = castType;
-/**
- * Namespace providing type-safe arithmetic operations for non-zero safe
- * integers.
- *
- * 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.
- */
 const NonZeroSafeInt = {
-    /**
-     * Type guard to check if a value is a NonZeroSafeInt.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-zero safe integer, `false` otherwise.
-     */
-    is,
-    /**
-     * The minimum safe integer value (-(2^53 - 1)).
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * The maximum safe integer value (2^53 - 1).
-     *
-     * @readonly
-     */
-    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.
-     */
-    abs,
-    /**
-     * Returns the smaller of two NonZeroSafeInt values.
-     *
-     * @param a The first NonZeroSafeInt.
-     * @param b The second NonZeroSafeInt.
-     * @returns The minimum value as a NonZeroSafeInt.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two NonZeroSafeInt values.
-     *
-     * @param a The first NonZeroSafeInt.
-     * @param b The second NonZeroSafeInt.
-     * @returns The maximum value as a NonZeroSafeInt.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the non-zero safe integer range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] \ {0} as
-     *   a NonZeroSafeInt.
-     */
-    clamp,
-    /**
-     * Generates a random NonZeroSafeInt value within the valid range.
-     *
-     * @returns A random non-zero safe integer between MIN_SAFE_INTEGER and
-     *   MAX_SAFE_INTEGER.
-     */
-    random,
-    /**
-     * Raises a NonZeroSafeInt to the power of another NonZeroSafeInt.
-     *
-     * @param a The base NonZeroSafeInt.
-     * @param b The exponent NonZeroSafeInt.
-     * @returns `a ** b` clamped to non-zero safe integer range 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}.
-     *
-     * @param a The first NonZeroSafeInt.
-     * @param b The second NonZeroSafeInt.
-     * @returns `a * b` clamped to non-zero safe integer range as a
-     *   NonZeroSafeInt.
-     */
-    mul,
+  /**
+   * Type guard to check if a value is a NonZeroSafeInt.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a non-zero safe integer, `false` otherwise.
+   */
+  is,
+  /**
+   * The minimum safe integer value (-(2^53 - 1)).
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * The maximum safe integer value (2^53 - 1).
+   *
+   * @readonly
+   */
+  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.
+   */
+  abs,
+  /**
+   * Returns the smaller of two NonZeroSafeInt values.
+   *
+   * @param a The first NonZeroSafeInt.
+   * @param b The second NonZeroSafeInt.
+   * @returns The minimum value as a NonZeroSafeInt.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two NonZeroSafeInt values.
+   *
+   * @param a The first NonZeroSafeInt.
+   * @param b The second NonZeroSafeInt.
+   * @returns The maximum value as a NonZeroSafeInt.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the non-zero safe integer range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to [MIN_SAFE_INTEGER, MAX_SAFE_INTEGER] \ {0} as
+   *   a NonZeroSafeInt.
+   */
+  clamp,
+  /**
+   * Generates a random NonZeroSafeInt value within the valid range.
+   *
+   * @returns A random non-zero safe integer between MIN_SAFE_INTEGER and
+   *   MAX_SAFE_INTEGER.
+   */
+  random,
+  /**
+   * Raises a NonZeroSafeInt to the power of another NonZeroSafeInt.
+   *
+   * @param a The base NonZeroSafeInt.
+   * @param b The exponent NonZeroSafeInt.
+   * @returns `a ** b` clamped to non-zero safe integer range 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}.
+   *
+   * @param a The first NonZeroSafeInt.
+   * @param b The second NonZeroSafeInt.
+   * @returns `a * b` clamped to non-zero safe integer range as a
+   *   NonZeroSafeInt.
+   */
+  mul
 };
 
 export { NonZeroSafeInt, asNonZeroSafeInt, isNonZeroSafeInt };

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":[null],"names":[],"mappings":";;AAYA,MAAM,iBAAiB,GAAG,yBAAyB;AAEnD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,aAAa,EAAE,MAAM,GACtB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,OAAO,EAAE,IAAI;;IAEb,SAAS,EAAE,MAAM,CAAC,gBAA2B;;IAE7C,SAAS,EAAE,MAAM,CAAC,gBAA4B;IAC9C,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;AAMG;AACI,MAAM,gBAAgB,GAAG;AAEhC;;;;;;AAMG;AACI,MAAM,gBAAgB,GAAG;AAEhC;;;;;;;;AAQG;AACI,MAAM,cAAc,GAAG;AAC5B;;;;;AAKG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;AAKG;IACH,GAAG;AAEH;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;IACH,KAAK;AAEL;;;;;AAKG;IACH,MAAM;AAEN;;;;;;;AAOG;IACH,GAAG;AAEH;;;;;;;;;;;AAWG;IACH,GAAG;;;;;"}
+{"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;;;;"}

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

@@ -16,19 +16,19 @@ export declare const isNonZeroUint16: (a: number) => a is import("ts-type-forge"
  * @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 NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
+    readonly "!=0": true;
+    readonly "< 2^16": true;
+    readonly "< 2^31": true;
+    readonly "< 2^32": 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 "< 2^16": true;
-    readonly "< 2^31": true;
-    readonly "< 2^32": true;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
     readonly SafeInt: true;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;

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

@@ -1,116 +1,105 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a non-zero integer in [1, 2^16)';
-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 ** 16 - 1,
-    typeNameInMessage,
+const typeNameInMessage = "a non-zero integer in [1, 2^16)";
+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 ** 16 - 1,
+  typeNameInMessage
 });
-/**
- * Checks if a number is a NonZeroUint16 (16-bit non-zero unsigned integer in
- * the range [1, 2^16)).
- *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroUint16, `false` otherwise.
- */
 const isNonZeroUint16 = is;
-/**
- * Casts a number to a NonZeroUint16 type.
- *
- * @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).
- */
 const asNonZeroUint16 = castType;
-/**
- * Namespace providing type-safe arithmetic operations for 16-bit non-zero
- * unsigned integers.
- *
- * 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.
- */
 const NonZeroUint16 = {
-    /**
-     * Type guard to check if a value is a NonZeroUint16.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a 16-bit non-zero unsigned integer, `false`
-     *   otherwise.
-     */
-    is,
-    /**
-     * The minimum value for a 16-bit non-zero unsigned integer.
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * The maximum value for a 16-bit non-zero unsigned integer.
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the smaller of two NonZeroUint16 values.
-     *
-     * @param a The first NonZeroUint16.
-     * @param b The second NonZeroUint16.
-     * @returns The minimum value as a NonZeroUint16.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two NonZeroUint16 values.
-     *
-     * @param a The first NonZeroUint16.
-     * @param b The second NonZeroUint16.
-     * @returns The maximum value as a NonZeroUint16.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the NonZeroUint16 range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to [1, 65535] as a NonZeroUint16.
-     */
-    clamp,
-    /**
-     * Generates a random NonZeroUint16 value within the valid range.
-     *
-     * @returns A random NonZeroUint16 between 1 and 65535.
-     */
-    random,
-    /**
-     * Raises a NonZeroUint16 to the power of another NonZeroUint16.
-     *
-     * @param a The base NonZeroUint16.
-     * @param b The exponent NonZeroUint16.
-     * @returns `a ** b` clamped to [1, 65535] as a NonZeroUint16.
-     */
-    pow,
-    /**
-     * Adds two NonZeroUint16 values.
-     *
-     * @param a The first NonZeroUint16.
-     * @param b The second NonZeroUint16.
-     * @returns `a + b` clamped to [1, 65535] as a NonZeroUint16.
-     */
-    add,
-    /**
-     * 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}.
-     *
-     * @param a The first NonZeroUint16.
-     * @param b The second NonZeroUint16.
-     * @returns `a * b` clamped to [1, 65535] as a NonZeroUint16.
-     */
-    mul,
+  /**
+   * Type guard to check if a value is a NonZeroUint16.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a 16-bit non-zero unsigned integer, `false`
+   *   otherwise.
+   */
+  is,
+  /**
+   * The minimum value for a 16-bit non-zero unsigned integer.
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * The maximum value for a 16-bit non-zero unsigned integer.
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the smaller of two NonZeroUint16 values.
+   *
+   * @param a The first NonZeroUint16.
+   * @param b The second NonZeroUint16.
+   * @returns The minimum value as a NonZeroUint16.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two NonZeroUint16 values.
+   *
+   * @param a The first NonZeroUint16.
+   * @param b The second NonZeroUint16.
+   * @returns The maximum value as a NonZeroUint16.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the NonZeroUint16 range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to [1, 65535] as a NonZeroUint16.
+   */
+  clamp,
+  /**
+   * Generates a random NonZeroUint16 value within the valid range.
+   *
+   * @returns A random NonZeroUint16 between 1 and 65535.
+   */
+  random,
+  /**
+   * Raises a NonZeroUint16 to the power of another NonZeroUint16.
+   *
+   * @param a The base NonZeroUint16.
+   * @param b The exponent NonZeroUint16.
+   * @returns `a ** b` clamped to [1, 65535] as a NonZeroUint16.
+   */
+  pow,
+  /**
+   * Adds two NonZeroUint16 values.
+   *
+   * @param a The first NonZeroUint16.
+   * @param b The second NonZeroUint16.
+   * @returns `a + b` clamped to [1, 65535] as a NonZeroUint16.
+   */
+  add,
+  /**
+   * 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}.
+   *
+   * @param a The first NonZeroUint16.
+   * @param b The second NonZeroUint16.
+   * @returns `a * b` clamped to [1, 65535] as a NonZeroUint16.
+   */
+  mul
 };
 
 export { NonZeroUint16, asNonZeroUint16, isNonZeroUint16 };

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":[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-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;;;;"}

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

@@ -16,17 +16,17 @@ export declare const isNonZeroUint32: (a: number) => a is import("ts-type-forge"
  * @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 NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
+    readonly "!=0": true;
+    readonly "< 2^32": 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 "< 2^32": true;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
     readonly SafeInt: true;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;