ts-data-forge 14.6.0 → 14.6.2

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

@@ -1,109 +1,122 @@
-import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = "a non-zero integer in [-2^31, 2^31)";
-const {
-  MAX_VALUE,
-  MIN_VALUE,
-  abs,
-  castType,
-  fromNumber,
-  is,
-  max: max_,
-  min: min_,
-  mul,
-  pow,
-  randomNonZero: random
-} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-  integerOrSafeInteger: "SafeInteger",
-  nonZero: true,
-  MIN_VALUE: -2147483648,
-  MAX_VALUE: 2 ** 31 - 1,
-  typeNameInMessage
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+const typeNameInMessage = 'a non-zero integer in [-2^31, 2^31)';
+const { MAX_VALUE, MIN_VALUE, abs, castType, fromNumber, is, max: max_, min: min_, mul, pow, randomNonZero: random, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+    integerOrSafeInteger: 'SafeInteger',
+    nonZero: true,
+    MIN_VALUE: -(2 ** 31),
+    MAX_VALUE: 2 ** 31 - 1,
+    typeNameInMessage,
 });
-const isNonZeroInt32 = is;
-const asNonZeroInt32 = castType;
-const NonZeroInt32 = {
-  /**
-   * Type guard that checks if a value is a non-zero integer in [-2^31, 2^31).
-   *
-   * @param value - The value to check
-   * @returns `true` if the value is a non-zero integer in [-2^31, 2^31), `false` otherwise
-   * @see {@link isNonZeroInt32} for usage examples
-   */
-  is,
-  /**
-   * The smallest value representable as `NonZeroInt32` (the lower saturation
-   * target of `fromNumber`).
-   */
-  MIN_VALUE,
-  /**
-   * The largest value representable as `NonZeroInt32` (the upper saturation
-   * target of `fromNumber`).
-   */
-  MAX_VALUE,
-  /**
-   * Returns the absolute value of a non-zero integer in [-2^31, 2^31).
-   *
-   * The result is non-negative and keeps the `NonZeroInt32` brand.
-   *
-   * @param a - The non-zero integer value
-   * @returns The absolute value as a non-negative `NonZeroInt32`
-   */
-  abs,
-  /**
-   * Returns the smallest of the given non-zero integers.
-   *
-   * @param values - The non-zero integers to compare (at least one required)
-   * @returns The smallest value as a `NonZeroInt32`
-   */
-  min: min_,
-  /**
-   * Returns the largest of the given non-zero integers.
-   *
-   * @param values - The non-zero integers to compare (at least one required)
-   * @returns The largest value as a `NonZeroInt32`
-   */
-  max: max_,
-  /**
-   * Converts an arbitrary `number` into a `NonZeroInt32`, rounding to the
-   * nearest integer and saturating the result into the range `[MIN_VALUE,
-   * MAX_VALUE]`.
-   *
-   * Unlike `asNonZeroInt32`, this is total: out-of-range inputs are clamped to
-   * the nearest representable `NonZeroInt32` instead of throwing.
-   *
-   * @param value - The value to convert
-   * @returns The value as a `NonZeroInt32`
-   */
-  fromNumber,
-  /**
-   * Generates a random `NonZeroInt32` within the given range.
-   *
-   * The range is inclusive on both ends.
-   *
-   * @param min - The minimum value (inclusive)
-   * @param max - The maximum value (inclusive)
-   * @returns A random `NonZeroInt32` in `[min, max]`
-   */
-  random,
-  /**
-   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroInt32`
-   * (floored to an integer).
-   *
-   * @param a - The base non-zero integer
-   * @param b - The exponent non-zero integer
-   * @returns `a ** b` as a `NonZeroInt32`
-   */
-  pow,
-  /**
-   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroInt32`.
-   *
-   * @param a - The first non-zero integer
-   * @param b - The second non-zero integer
-   * @returns The product of `a` and `b` as a `NonZeroInt32`
-   */
-  mul
+/**
+ * Type guard that checks if a value is a non-zero integer in [-2^31, 2^31).
+ *
+ * Returns `true` for a non-zero integer in [-2^31, 2^31) — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero integer in [-2^31, 2^31), `false` otherwise
+ */
+export const isNonZeroInt32 = is;
+/**
+ * Casts a `number` to the `NonZeroInt32` branded type.
+ *
+ * Validates that the value is a non-zero integer in [-2^31, 2^31) and returns
+ * it with the `NonZeroInt32` brand. Throws a `TypeError` otherwise.
+ *
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroInt32`
+ * @throws {TypeError} If the value is not a non-zero integer in [-2^31, 2^31)
+ */
+export const asNonZeroInt32 = castType;
+/**
+ * Namespace providing type-safe operations for the `NonZeroInt32` branded type.
+ *
+ * The `NonZeroInt32` type represents a non-zero integer in [-2^31, 2^31).
+ * Division (`div`) uses floor division.
+ */
+export const NonZeroInt32 = {
+    /**
+     * Type guard that checks if a value is a non-zero integer in [-2^31, 2^31).
+     *
+     * @param value - The value to check
+     * @returns `true` if the value is a non-zero integer in [-2^31, 2^31), `false` otherwise
+     * @see {@link isNonZeroInt32} for usage examples
+     */
+    is,
+    /**
+     * The smallest value representable as `NonZeroInt32` (the lower saturation
+     * target of `fromNumber`).
+     */
+    MIN_VALUE,
+    /**
+     * The largest value representable as `NonZeroInt32` (the upper saturation
+     * target of `fromNumber`).
+     */
+    MAX_VALUE,
+    /**
+     * Returns the absolute value of a non-zero integer in [-2^31, 2^31).
+     *
+     * The result is non-negative and keeps the `NonZeroInt32` brand.
+     *
+     * @param a - The non-zero integer value
+     * @returns The absolute value as a non-negative `NonZeroInt32`
+     */
+    abs,
+    /**
+     * Returns the smallest of the given non-zero integers.
+     *
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroInt32`
+     */
+    min: min_,
+    /**
+     * Returns the largest of the given non-zero integers.
+     *
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The largest value as a `NonZeroInt32`
+     */
+    max: max_,
+    /**
+     * Converts an arbitrary `number` into a `NonZeroInt32`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asNonZeroInt32`, this is total: out-of-range inputs are clamped to
+     * the nearest representable `NonZeroInt32` instead of throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `NonZeroInt32`
+     */
+    fromNumber,
+    /**
+     * Generates a random `NonZeroInt32` within the given range.
+     *
+     * The range is inclusive on both ends.
+     *
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonZeroInt32` in `[min, max]`
+     */
+    random,
+    /**
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroInt32`
+     * (floored to an integer).
+     *
+     * @param a - The base non-zero integer
+     * @param b - The exponent non-zero integer
+     * @returns `a ** b` as a `NonZeroInt32`
+     */
+    pow,
+    /**
+     * Multiplies two non-zero integers, returning `a * b` as a `NonZeroInt32`.
+     *
+     * @param a - The first non-zero integer
+     * @param b - The second non-zero integer
+     * @returns The product of `a` and `b` as a `NonZeroInt32`
+     */
+    mul,
 };
 
-export { NonZeroInt32, asNonZeroInt32, isNonZeroInt32 };
-//# sourceMappingURL=non-zero-int32.mjs.map
+
+//# sourceMappingURL=non-zero-int32.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-int32.mjs","sources":["../../../src/number/branded-types/non-zero-int32.mts"],"sourcesContent":["import { type NonZeroInt32 as TtfImported_NonZeroInt32 } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroInt32 = TtfImported_NonZeroInt32;\n\ntype ElementType = NonZeroInt32;\n\nconst typeNameInMessage = 'a non-zero integer in [-2^31, 2^31)';\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  number,\n  number\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\n  MIN_VALUE: -(2 ** 31),\n  MAX_VALUE: 2 ** 31 - 1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-zero integer in [-2^31, 2^31).\n *\n * Returns `true` for a non-zero integer in [-2^31, 2^31) — 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 [-2^31, 2^31), `false` otherwise\n */\nexport const isNonZeroInt32 = is;\n\n/**\n * Casts a `number` to the `NonZeroInt32` branded type.\n *\n * Validates that the value is a non-zero integer in [-2^31, 2^31) and returns\n * it with the `NonZeroInt32` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroInt32`\n * @throws {TypeError} If the value is not a non-zero integer in [-2^31, 2^31)\n */\nexport const asNonZeroInt32 = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroInt32` branded type.\n *\n * The `NonZeroInt32` type represents a non-zero integer in [-2^31, 2^31).\n * Division (`div`) uses floor division.\n */\nexport const NonZeroInt32 = {\n  /**\n   * Type guard that checks if a value is a non-zero integer in [-2^31, 2^31).\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero integer in [-2^31, 2^31), `false` otherwise\n   * @see {@link isNonZeroInt32} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonZeroInt32` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonZeroInt32` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a non-zero integer in [-2^31, 2^31).\n   *\n   * The result is non-negative and keeps the `NonZeroInt32` brand.\n   *\n   * @param a - The non-zero integer value\n   * @returns The absolute value as a non-negative `NonZeroInt32`\n   */\n  abs,\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 `NonZeroInt32`\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 `NonZeroInt32`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonZeroInt32`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNonZeroInt32`, this is total: out-of-range inputs are clamped to\n   * the nearest representable `NonZeroInt32` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonZeroInt32`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NonZeroInt32` 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 `NonZeroInt32` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroInt32`\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 `NonZeroInt32`\n   */\n  pow,\n\n  /**\n   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroInt32`.\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 `NonZeroInt32`\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroInt32,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range',\n    'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroInt32,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'range',\n    'mul'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,qCAAA;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,EACT,SAAA,EAAW,WAAO;AAAA,EAClB,SAAA,EAAW,KAAK,EAAA,GAAK,CAAA;AAAA,EACrB;AACF,CAAU,CAAA;AAWH,MAAM,cAAA,GAAiB;AAYvB,MAAM,cAAA,GAAiB;AAQvB,MAAM,YAAA,GAAe;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ1B,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,EASA;AACF;;;;"}
+{"version":3,"file":"non-zero-int32.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-int32.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,qCAAqC,CAAC;AAEhE,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,UAAU,EACV,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;IACA,oBAAoB,EAAE,aAAa;IACnC,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACrB,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IACtB,iBAAiB;CACT,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,EAAE,CAAC;AAEjC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,QAAQ,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B;;;;;;OAMG;IACH,EAAE;IAEF;;;OAGG;IACH,SAAS;IAET;;;OAGG;IACH,SAAS;IAET;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;;OAUG;IACH,UAAU;IAEV;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;OAMG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAOR,GAAG,CAAC,CAAC;AAEP,UAAU,CAOR,IAAI,CAAC,CAAC"}

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

@@ -1,112 +1,126 @@
-import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = "a non-zero safe integer";
-const {
-  MAX_VALUE,
-  MIN_VALUE,
-  abs,
-  castType,
-  fromNumber,
-  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
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+const typeNameInMessage = 'a non-zero safe integer';
+const { MAX_VALUE, MIN_VALUE, abs, castType, fromNumber, 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 isNonZeroSafeInt = is;
-const asNonZeroSafeInt = castType;
-const 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
-   * @see {@link isNonZeroSafeInt} for usage examples
-   */
-  is,
-  /**
-   * The smallest value representable as `NonZeroSafeInt` (the lower saturation
-   * target of `fromNumber`).
-   */
-  MIN_VALUE,
-  /**
-   * The largest value representable as `NonZeroSafeInt` (the upper saturation
-   * target of `fromNumber`).
-   */
-  MAX_VALUE,
-  /**
-   * Returns the absolute value of a non-zero safe integer.
-   *
-   * 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 smallest of the given non-zero safe integers.
-   *
-   * @param values - The non-zero safe integers to compare (at least one required)
-   * @returns The smallest value as a `NonZeroSafeInt`
-   */
-  min: min_,
-  /**
-   * Returns the largest of the given non-zero safe integers.
-   *
-   * @param values - The non-zero safe integers to compare (at least one required)
-   * @returns The largest value as a `NonZeroSafeInt`
-   */
-  max: max_,
-  /**
-   * 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 value to convert
-   * @returns The value as a `NonZeroSafeInt`
-   */
-  fromNumber,
-  /**
-   * Generates a random `NonZeroSafeInt` within the given range.
-   *
-   * 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]`
-   */
-  random,
-  /**
-   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroSafeInt`
-   * (floored to an integer).
-   *
-   * @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 non-zero safe integers, returning `a * b` 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
+/**
+ * Type guard that checks if a value is a non-zero safe integer.
+ *
+ * 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 const isNonZeroSafeInt = is;
+/**
+ * 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`
+ * @throws {TypeError} If the value is not a non-zero safe integer
+ */
+export const asNonZeroSafeInt = castType;
+/**
+ * Namespace providing type-safe operations for the `NonZeroSafeInt` branded
+ * type.
+ *
+ * The `NonZeroSafeInt` type represents a non-zero safe integer. Division
+ * (`div`) uses floor division.
+ */
+export const 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
+     * @see {@link isNonZeroSafeInt} for usage examples
+     */
+    is,
+    /**
+     * The smallest value representable as `NonZeroSafeInt` (the lower saturation
+     * target of `fromNumber`).
+     */
+    MIN_VALUE,
+    /**
+     * The largest value representable as `NonZeroSafeInt` (the upper saturation
+     * target of `fromNumber`).
+     */
+    MAX_VALUE,
+    /**
+     * Returns the absolute value of a non-zero safe integer.
+     *
+     * 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 smallest of the given non-zero safe integers.
+     *
+     * @param values - The non-zero safe integers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroSafeInt`
+     */
+    min: min_,
+    /**
+     * Returns the largest of the given non-zero safe integers.
+     *
+     * @param values - The non-zero safe integers to compare (at least one required)
+     * @returns The largest value as a `NonZeroSafeInt`
+     */
+    max: max_,
+    /**
+     * 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 value to convert
+     * @returns The value as a `NonZeroSafeInt`
+     */
+    fromNumber,
+    /**
+     * Generates a random `NonZeroSafeInt` within the given range.
+     *
+     * 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]`
+     */
+    random,
+    /**
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroSafeInt`
+     * (floored to an integer).
+     *
+     * @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 non-zero safe integers, returning `a * b` 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,
 };
 
-export { NonZeroSafeInt, asNonZeroSafeInt, isNonZeroSafeInt };
-//# sourceMappingURL=non-zero-safe-int.mjs.map
+
+//# sourceMappingURL=non-zero-safe-int.mjs.map

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  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;;;;"}
+{"version":3,"file":"non-zero-safe-int.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-safe-int.mts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,yBAAyB,CAAC;AAEpD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,UAAU,EACV,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;IACA,oBAAoB,EAAE,aAAa;IACnC,OAAO,EAAE,IAAI;IACb,yGAAyG;IACzG,SAAS,EAAE,MAAM,CAAC,gBAA2B;IAC7C,yGAAyG;IACzG,SAAS,EAAE,MAAM,CAAC,gBAA4B;IAC9C,iBAAiB;CACT,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAEnC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B;;;;;;OAMG;IACH,EAAE;IAEF;;;OAGG;IACH,SAAS;IAET;;;OAGG;IACH,SAAS;IAET;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;;OAUG;IACH,UAAU;IAEV;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAOR,GAAG,CAAC,CAAC;AAEP,UAAU,CAOR,IAAI,CAAC,CAAC"}