ts-data-forge 14.6.1 → 14.6.2

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

@@ -1,110 +1,121 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
-
-const typeNameInMessage = "a non-positive safe integer";
-const {
-  MAX_VALUE,
-  MIN_VALUE,
-  add,
-  castType,
-  fromNumber,
-  is,
-  max: max_,
-  min: min_,
-  pow,
-  random,
-  sub
-} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-  integerOrSafeInteger: "SafeInteger",
-  MIN_VALUE: Number.MIN_SAFE_INTEGER,
-  MAX_VALUE: 0,
-  typeNameInMessage
+const typeNameInMessage = 'a non-positive safe integer';
+const { MAX_VALUE, MIN_VALUE, add, castType, fromNumber, is, max: max_, min: min_, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+    integerOrSafeInteger: 'SafeInteger',
+    MIN_VALUE: Number.MIN_SAFE_INTEGER,
+    MAX_VALUE: 0,
+    typeNameInMessage,
 });
-const isNonPositiveSafeInt = is;
-const asNonPositiveSafeInt = castType;
-const NonPositiveSafeInt = {
-  /**
-   * Type guard that checks if a value is a non-positive safe integer.
-   *
-   * @param value - The value to check
-   * @returns `true` if the value is a non-positive safe integer, `false` otherwise
-   * @see {@link isNonPositiveSafeInt} for usage examples
-   */
-  is,
-  /**
-   * The smallest value representable as `NonPositiveSafeInt` (the lower
-   * saturation target of `fromNumber`).
-   */
-  MIN_VALUE,
-  /**
-   * The largest value representable as `NonPositiveSafeInt` (the upper
-   * saturation target of `fromNumber`).
-   */
-  MAX_VALUE,
-  /**
-   * Returns the smallest of the given non-positive safe integers.
-   *
-   * @param values - The non-positive safe integers to compare (at least one required)
-   * @returns The smallest value as a `NonPositiveSafeInt`
-   */
-  min: min_,
-  /**
-   * Returns the largest of the given non-positive safe integers.
-   *
-   * @param values - The non-positive safe integers to compare (at least one required)
-   * @returns The largest value as a `NonPositiveSafeInt`
-   */
-  max: max_,
-  /**
-   * Converts an arbitrary `number` into a `NonPositiveSafeInt`, rounding to the
-   * nearest integer and saturating the result into the range `[MIN_VALUE,
-   * MAX_VALUE]`.
-   *
-   * Unlike `asNonPositiveSafeInt`, this is total: out-of-range inputs are
-   * clamped to the nearest representable `NonPositiveSafeInt` instead of
-   * throwing.
-   *
-   * @param value - The value to convert
-   * @returns The value as a `NonPositiveSafeInt`
-   */
-  fromNumber,
-  /**
-   * Generates a random `NonPositiveSafeInt` 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 `NonPositiveSafeInt` in `[min, max]`
-   */
-  random,
-  /**
-   * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveSafeInt`
-   * (floored to an integer).
-   *
-   * @param a - The base non-positive safe integer
-   * @param b - The exponent non-positive safe integer
-   * @returns `a ** b` as a `NonPositiveSafeInt`
-   */
-  pow,
-  /**
-   * Adds two non-positive safe integers, returning `a + b` as a
-   * `NonPositiveSafeInt`.
-   *
-   * @param a - The first non-positive safe integer
-   * @param b - The second non-positive safe integer
-   * @returns The sum of `a` and `b` as a `NonPositiveSafeInt`
-   */
-  add,
-  /**
-   * Subtracts two non-positive safe integers, returning `a - b` as a
-   * `NonPositiveSafeInt`.
-   *
-   * @param a - The first non-positive safe integer
-   * @param b - The second non-positive safe integer
-   * @returns The difference of `a` and `b` as a `NonPositiveSafeInt`
-   */
-  sub
+/**
+ * Type guard that checks if a value is a non-positive safe integer.
+ *
+ * Returns `true` for a non-positive safe integer — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-positive safe integer, `false` otherwise
+ */
+export const isNonPositiveSafeInt = is;
+/**
+ * Casts a `number` to the `NonPositiveSafeInt` branded type.
+ *
+ * Validates that the value is a non-positive safe integer and returns it with
+ * the `NonPositiveSafeInt` brand. Throws a `TypeError` otherwise.
+ *
+ * @param value - The value to cast
+ * @returns The value as a `NonPositiveSafeInt`
+ * @throws {TypeError} If the value is not a non-positive safe integer
+ */
+export const asNonPositiveSafeInt = castType;
+/**
+ * Namespace providing type-safe operations for the `NonPositiveSafeInt` branded
+ * type.
+ *
+ * The `NonPositiveSafeInt` type represents a non-positive safe integer.
+ * Division (`div`) uses floor division.
+ */
+export const NonPositiveSafeInt = {
+    /**
+     * Type guard that checks if a value is a non-positive safe integer.
+     *
+     * @param value - The value to check
+     * @returns `true` if the value is a non-positive safe integer, `false` otherwise
+     * @see {@link isNonPositiveSafeInt} for usage examples
+     */
+    is,
+    /**
+     * The smallest value representable as `NonPositiveSafeInt` (the lower
+     * saturation target of `fromNumber`).
+     */
+    MIN_VALUE,
+    /**
+     * The largest value representable as `NonPositiveSafeInt` (the upper
+     * saturation target of `fromNumber`).
+     */
+    MAX_VALUE,
+    /**
+     * Returns the smallest of the given non-positive safe integers.
+     *
+     * @param values - The non-positive safe integers to compare (at least one required)
+     * @returns The smallest value as a `NonPositiveSafeInt`
+     */
+    min: min_,
+    /**
+     * Returns the largest of the given non-positive safe integers.
+     *
+     * @param values - The non-positive safe integers to compare (at least one required)
+     * @returns The largest value as a `NonPositiveSafeInt`
+     */
+    max: max_,
+    /**
+     * Converts an arbitrary `number` into a `NonPositiveSafeInt`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asNonPositiveSafeInt`, this is total: out-of-range inputs are
+     * clamped to the nearest representable `NonPositiveSafeInt` instead of
+     * throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `NonPositiveSafeInt`
+     */
+    fromNumber,
+    /**
+     * Generates a random `NonPositiveSafeInt` 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 `NonPositiveSafeInt` in `[min, max]`
+     */
+    random,
+    /**
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveSafeInt`
+     * (floored to an integer).
+     *
+     * @param a - The base non-positive safe integer
+     * @param b - The exponent non-positive safe integer
+     * @returns `a ** b` as a `NonPositiveSafeInt`
+     */
+    pow,
+    /**
+     * Adds two non-positive safe integers, returning `a + b` as a
+     * `NonPositiveSafeInt`.
+     *
+     * @param a - The first non-positive safe integer
+     * @param b - The second non-positive safe integer
+     * @returns The sum of `a` and `b` as a `NonPositiveSafeInt`
+     */
+    add,
+    /**
+     * Subtracts two non-positive safe integers, returning `a - b` as a
+     * `NonPositiveSafeInt`.
+     *
+     * @param a - The first non-positive safe integer
+     * @param b - The second non-positive safe integer
+     * @returns The difference of `a` and `b` as a `NonPositiveSafeInt`
+     */
+    sub,
 };
-
-export { NonPositiveSafeInt, asNonPositiveSafeInt, isNonPositiveSafeInt };
-//# sourceMappingURL=non-positive-safe-int.mjs.map
+//# sourceMappingURL=non-positive-safe-int.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"non-positive-safe-int.mjs","sources":["../../../src/number/branded-types/non-positive-safe-int.mts"],"sourcesContent":["import { type NonPositiveSafeInt as TtfImported_NonPositiveSafeInt } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonPositiveSafeInt = TtfImported_NonPositiveSafeInt;\n\ntype ElementType = NonPositiveSafeInt;\n\nconst typeNameInMessage = 'a non-positive safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  0\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: 0,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-positive safe integer.\n *\n * Returns `true` for a non-positive 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-positive safe integer, `false` otherwise\n */\nexport const isNonPositiveSafeInt = is;\n\n/**\n * Casts a `number` to the `NonPositiveSafeInt` branded type.\n *\n * Validates that the value is a non-positive safe integer and returns it with\n * the `NonPositiveSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonPositiveSafeInt`\n * @throws {TypeError} If the value is not a non-positive safe integer\n */\nexport const asNonPositiveSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonPositiveSafeInt` branded\n * type.\n *\n * The `NonPositiveSafeInt` type represents a non-positive safe integer.\n * Division (`div`) uses floor division.\n */\nexport const NonPositiveSafeInt = {\n  /**\n   * Type guard that checks if a value is a non-positive safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-positive safe integer, `false` otherwise\n   * @see {@link isNonPositiveSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonPositiveSafeInt` (the lower\n   * saturation target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonPositiveSafeInt` (the upper\n   * saturation target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-positive safe integers.\n   *\n   * @param values - The non-positive safe integers to compare (at least one required)\n   * @returns The smallest value as a `NonPositiveSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-positive safe integers.\n   *\n   * @param values - The non-positive safe integers to compare (at least one required)\n   * @returns The largest value as a `NonPositiveSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonPositiveSafeInt`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNonPositiveSafeInt`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `NonPositiveSafeInt` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonPositiveSafeInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NonPositiveSafeInt` 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 `NonPositiveSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveSafeInt`\n   * (floored to an integer).\n   *\n   * @param a - The base non-positive safe integer\n   * @param b - The exponent non-positive safe integer\n   * @returns `a ** b` as a `NonPositiveSafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two non-positive safe integers, returning `a + b` as a\n   * `NonPositiveSafeInt`.\n   *\n   * @param a - The first non-positive safe integer\n   * @param b - The second non-positive safe integer\n   * @returns The sum of `a` and `b` as a `NonPositiveSafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two non-positive safe integers, returning `a - b` as a\n   * `NonPositiveSafeInt`.\n   *\n   * @param a - The first non-positive safe integer\n   * @param b - The second non-positive safe integer\n   * @returns The difference of `a` and `b` as a `NonPositiveSafeInt`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;AAOA,MAAM,iBAAA,GAAoB,6BAAA;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,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,CAAA;AAAA,EACX;AACF,CAAU,CAAA;AAWH,MAAM,oBAAA,GAAuB;AAY7B,MAAM,oBAAA,GAAuB;AAS7B,MAAM,kBAAA,GAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQhC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcL,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,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}
+{"version":3,"file":"non-positive-safe-int.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-safe-int.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AAExD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,UAAU,EACV,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;IACA,oBAAoB,EAAE,aAAa;IACnC,SAAS,EAAE,MAAM,CAAC,gBAAgB;IAClC,SAAS,EAAE,CAAC;IACZ,iBAAiB;CACT,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEvC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAE7C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC;;;;;;OAMG;IACH,EAAE;IAEF;;;OAGG;IACH,SAAS;IAET;;;OAGG;IACH,SAAS;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;;;OAWG;IACH,UAAU;IAEV;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;CACK,CAAC"}

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

@@ -1,133 +1,148 @@
-import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = "a non-zero finite number";
-const {
-  abs,
-  castType,
-  div,
-  is,
-  max: max_,
-  min: min_,
-  mul,
-  pow,
-  randomNonZero: random
-} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
-  nonZero: true,
-  MIN_VALUE: -Number.MAX_VALUE,
-  MAX_VALUE: Number.MAX_VALUE,
-  typeNameInMessage
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+const typeNameInMessage = 'a non-zero finite number';
+const { abs, castType, div, is, max: max_, min: min_, mul, pow, randomNonZero: random, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+    nonZero: true,
+    MIN_VALUE: -Number.MAX_VALUE,
+    MAX_VALUE: Number.MAX_VALUE,
+    typeNameInMessage,
 });
-const floor = (x) => (
-  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-  Math.floor(x)
-);
-const ceil = (x) => (
-  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-  Math.ceil(x)
-);
-const round = (x) => (
-  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
-  Math.round(x)
-);
-const isNonZeroFiniteNumber = is;
-const asNonZeroFiniteNumber = castType;
-const NonZeroFiniteNumber = {
-  /**
-   * Type guard that checks if a value is a non-zero finite number.
-   *
-   * @param value - The value to check
-   * @returns `true` if the value is a non-zero finite number, `false` otherwise
-   * @see {@link isNonZeroFiniteNumber} for usage examples
-   */
-  is,
-  /**
-   * Returns the absolute value of a non-zero finite number.
-   *
-   * The result is non-negative and keeps the `NonZeroFiniteNumber` brand.
-   *
-   * @param a - The non-zero finite number value
-   * @returns The absolute value as a non-negative `NonZeroFiniteNumber`
-   */
-  abs,
-  /**
-   * Returns the smallest of the given non-zero finite numbers.
-   *
-   * @param values - The non-zero finite numbers to compare (at least one required)
-   * @returns The smallest value as a `NonZeroFiniteNumber`
-   */
-  min: min_,
-  /**
-   * Returns the largest of the given non-zero finite numbers.
-   *
-   * @param values - The non-zero finite numbers to compare (at least one required)
-   * @returns The largest value as a `NonZeroFiniteNumber`
-   */
-  max: max_,
-  /**
-   * Returns the greatest integer less than or equal to a non-zero finite
-   * number.
-   *
-   * @param a - The non-zero finite number value
-   * @returns The floored value as an integer
-   */
-  floor,
-  /**
-   * Returns the smallest integer greater than or equal to a non-zero finite
-   * number.
-   *
-   * @param a - The non-zero finite number value
-   * @returns The ceiled value as an integer
-   */
-  ceil,
-  /**
-   * Returns the value of a non-zero finite number rounded to the nearest
-   * integer.
-   *
-   * @param a - The non-zero finite number value
-   * @returns The rounded value as an integer
-   */
-  round,
-  /**
-   * Generates a random `NonZeroFiniteNumber` 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 `NonZeroFiniteNumber` in `[min, max]`
-   */
-  random,
-  /**
-   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroFiniteNumber`.
-   *
-   * @param a - The base non-zero finite number
-   * @param b - The exponent non-zero finite number
-   * @returns `a ** b` as a `NonZeroFiniteNumber`
-   */
-  pow,
-  /**
-   * Multiplies two non-zero finite numbers, returning `a * b` as a
-   * `NonZeroFiniteNumber`.
-   *
-   * @param a - The first non-zero finite number
-   * @param b - The second non-zero finite number
-   * @returns The product of `a` and `b` as a `NonZeroFiniteNumber`
-   */
-  mul,
-  /**
-   * Divides two non-zero finite numbers, returning `a / b` as a
-   * `NonZeroFiniteNumber`.
-   *
-   * Exact (non-flooring) division of two non-zero finite numbers is always
-   * non-zero, so this stays closed. For the non-closed operations (`add`/`sub`,
-   * whose result may be `0`) use {@link Num.add}/{@link Num.sub}.
-   *
-   * @param a - The dividend
-   * @param b - The divisor (must be non-zero)
-   * @returns `a / b` as a `NonZeroFiniteNumber`
-   */
-  div
+const floor = (x) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+Math.floor(x);
+const ceil = (x) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+Math.ceil(x);
+const round = (x) => 
+// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+Math.round(x);
+
+
+/**
+ * Type guard that checks if a value is a non-zero finite number.
+ *
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero finite number, `false` otherwise
+ */
+export const isNonZeroFiniteNumber = is;
+/**
+ * Casts a `number` to the `NonZeroFiniteNumber` branded type.
+ *
+ * Validates that the value is a non-zero finite number and returns it with the
+ * `NonZeroFiniteNumber` brand. Throws a `TypeError` otherwise.
+ *
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroFiniteNumber`
+ * @throws {TypeError} If the value is not a non-zero finite number
+ */
+export const asNonZeroFiniteNumber = castType;
+/**
+ * Namespace providing type-safe operations for the `NonZeroFiniteNumber`
+ * branded type.
+ *
+ * The `NonZeroFiniteNumber` type represents a non-zero finite number.
+ */
+export const NonZeroFiniteNumber = {
+    /**
+     * Type guard that checks if a value is a non-zero finite number.
+     *
+     * @param value - The value to check
+     * @returns `true` if the value is a non-zero finite number, `false` otherwise
+     * @see {@link isNonZeroFiniteNumber} for usage examples
+     */
+    is,
+    /**
+     * Returns the absolute value of a non-zero finite number.
+     *
+     * The result is non-negative and keeps the `NonZeroFiniteNumber` brand.
+     *
+     * @param a - The non-zero finite number value
+     * @returns The absolute value as a non-negative `NonZeroFiniteNumber`
+     */
+    abs,
+    /**
+     * Returns the smallest of the given non-zero finite numbers.
+     *
+     * @param values - The non-zero finite numbers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroFiniteNumber`
+     */
+    min: min_,
+    /**
+     * Returns the largest of the given non-zero finite numbers.
+     *
+     * @param values - The non-zero finite numbers to compare (at least one required)
+     * @returns The largest value as a `NonZeroFiniteNumber`
+     */
+    max: max_,
+    /**
+     * Returns the greatest integer less than or equal to a non-zero finite
+     * number.
+     *
+     * @param a - The non-zero finite number value
+     * @returns The floored value as an integer
+     */
+    floor,
+    /**
+     * Returns the smallest integer greater than or equal to a non-zero finite
+     * number.
+     *
+     * @param a - The non-zero finite number value
+     * @returns The ceiled value as an integer
+     */
+    ceil,
+    /**
+     * Returns the value of a non-zero finite number rounded to the nearest
+     * integer.
+     *
+     * @param a - The non-zero finite number value
+     * @returns The rounded value as an integer
+     */
+    round,
+    /**
+     * Generates a random `NonZeroFiniteNumber` 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 `NonZeroFiniteNumber` in `[min, max]`
+     */
+    random,
+    /**
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroFiniteNumber`.
+     *
+     * @param a - The base non-zero finite number
+     * @param b - The exponent non-zero finite number
+     * @returns `a ** b` as a `NonZeroFiniteNumber`
+     */
+    pow,
+    /**
+     * Multiplies two non-zero finite numbers, returning `a * b` as a
+     * `NonZeroFiniteNumber`.
+     *
+     * @param a - The first non-zero finite number
+     * @param b - The second non-zero finite number
+     * @returns The product of `a` and `b` as a `NonZeroFiniteNumber`
+     */
+    mul,
+    /**
+     * Divides two non-zero finite numbers, returning `a / b` as a
+     * `NonZeroFiniteNumber`.
+     *
+     * Exact (non-flooring) division of two non-zero finite numbers is always
+     * non-zero, so this stays closed. For the non-closed operations (`add`/`sub`,
+     * whose result may be `0`) use {@link Num.add}/{@link Num.sub}.
+     *
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns `a / b` as a `NonZeroFiniteNumber`
+     */
+    div,
 };
 
-export { NonZeroFiniteNumber, asNonZeroFiniteNumber, isNonZeroFiniteNumber };
-//# sourceMappingURL=non-zero-finite-number.mjs.map
+
+
+//# sourceMappingURL=non-zero-finite-number.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-finite-number.mjs","sources":["../../../src/number/branded-types/non-zero-finite-number.mts"],"sourcesContent":["import {\n  type Int,\n  type NonZeroInt,\n  type PositiveFiniteNumber,\n  type NonZeroFiniteNumber as TtfImported_NonZeroFiniteNumber,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroFiniteNumber = TtfImported_NonZeroFiniteNumber;\n\ntype ElementType = NonZeroFiniteNumber;\n\nconst typeNameInMessage = 'a non-zero finite number';\n\nconst {\n  abs,\n  castType,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  NonZeroInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Int\n>('=');\n\n/**\n * Type guard that checks if a value is a non-zero finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-zero finite number, `false` otherwise\n */\nexport const isNonZeroFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonZeroFiniteNumber` branded type.\n *\n * Validates that the value is a non-zero finite number and returns it with the\n * `NonZeroFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroFiniteNumber`\n * @throws {TypeError} If the value is not a non-zero finite number\n */\nexport const asNonZeroFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroFiniteNumber`\n * branded type.\n *\n * The `NonZeroFiniteNumber` type represents a non-zero finite number.\n */\nexport const NonZeroFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-zero finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero finite number, `false` otherwise\n   * @see {@link isNonZeroFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * Returns the absolute value of a non-zero finite number.\n   *\n   * The result is non-negative and keeps the `NonZeroFiniteNumber` brand.\n   *\n   * @param a - The non-zero finite number value\n   * @returns The absolute value as a non-negative `NonZeroFiniteNumber`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given non-zero finite numbers.\n   *\n   * @param values - The non-zero finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero finite numbers.\n   *\n   * @param values - The non-zero finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonZeroFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-zero finite\n   * number.\n   *\n   * @param a - The non-zero finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a non-zero finite\n   * number.\n   *\n   * @param a - The non-zero finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-zero finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-zero finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonZeroFiniteNumber` 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 `NonZeroFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroFiniteNumber`.\n   *\n   * @param a - The base non-zero finite number\n   * @param b - The exponent non-zero finite number\n   * @returns `a ** b` as a `NonZeroFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Multiplies two non-zero finite numbers, returning `a * b` as a\n   * `NonZeroFiniteNumber`.\n   *\n   * @param a - The first non-zero finite number\n   * @param b - The second non-zero finite number\n   * @returns The product of `a` and `b` as a `NonZeroFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two non-zero finite numbers, returning `a / b` as a\n   * `NonZeroFiniteNumber`.\n   *\n   * Exact (non-flooring) division of two non-zero finite numbers is always\n   * non-zero, so this stays closed. For the non-closed operations (`add`/`sub`,\n   * whose result may be `0`) use {@link Num.add}/{@link Num.sub}.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `NonZeroFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToNonNegative<ElementType>,\n  PositiveFiniteNumber\n>('=');\n\nexpectType<\n  keyof typeof NonZeroFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    never,\n    'div' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    never,\n    'div' | 'mul'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAaA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;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,iBAAA,CAI1C;AAAA,EACA,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAuBP,MAAM,qBAAA,GAAwB;AAY9B,MAAM,qBAAA,GAAwB;AAQ9B,MAAM,mBAAA,GAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjC,EAAA;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,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA;AACF;;;;"}
+{"version":3,"file":"non-zero-finite-number.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-finite-number.mts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,0BAA0B,CAAC;AAErD,MAAM,EACJ,GAAG,EACH,QAAQ,EACR,GAAG,EACH,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,aAAa,EAAE,MAAM,GACtB,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,iBAAiB,CAI3D;IACA,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS;IAC5B,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,iBAAiB;CACT,CAAC,CAAC;AAEZ,MAAM,KAAK,GAAG,CACZ,CAAc,EAC8C,EAAE;AAC9D,oEAAoE;AACpE,IAAI,CAAC,KAAK,CAAC,CAAC,CAA+D,CAAC;AAE9E,MAAM,IAAI,GAAG,CACX,CAAc,EAC8C,EAAE;AAC9D,oEAAoE;AACpE,IAAI,CAAC,IAAI,CAAC,CAAC,CAA+D,CAAC;AAE7E,MAAM,KAAK,GAAG,CACZ,CAAc,EAC8C,EAAE;AAC9D,oEAAoE;AACpE,IAAI,CAAC,KAAK,CAAC,CAAC,CAA+D,CAAC;AAE9E,UAAU,CAGR,GAAG,CAAC,CAAC;AAEP,UAAU,CAKR,GAAG,CAAC,CAAC;AAEP;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAExC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC;;;;;;OAMG;IACH,EAAE;IAEF;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;OAMG;IACH,KAAK;IAEL;;;;;;OAMG;IACH,IAAI;IAEJ;;;;;;OAMG;IACH,KAAK;IAEL;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;OAMG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;;;;;OAWG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAGR,GAAG,CAAC,CAAC;AAEP,UAAU,CAOR,GAAG,CAAC,CAAC;AAEP,UAAU,CAOR,IAAI,CAAC,CAAC"}