ts-data-forge 14.6.0 → 14.6.2

package/dist/number/branded-types/negative-safe-int.mjs

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

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

@@ -1 +1 @@
-{"version":3,"file":"negative-safe-int.mjs","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"sourcesContent":["import {\n  type NegativeSafeInt as TtfImported_NegativeSafeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveSafeInt } from './positive-safe-int.mjs';\n\nexport type NegativeSafeInt = TtfImported_NegativeSafeInt;\n\ntype ElementType = NegativeSafeInt;\n\nconst typeNameInMessage = 'a negative 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  -1\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  nonZero: true,\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\nconst abs = (x: WithSmallInt<ElementType>): PositiveSafeInt =>\n  PositiveSafeInt.fromNumber(Math.abs(x));\n\n/**\n * Type guard that checks if a value is a negative safe integer.\n *\n * Returns `true` for a negative 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 negative safe integer, `false` otherwise\n */\nexport const isNegativeSafeInt = is;\n\n/**\n * Casts a `number` to the `NegativeSafeInt` branded type.\n *\n * Validates that the value is a negative safe integer and returns it with the\n * `NegativeSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NegativeSafeInt`\n * @throws {TypeError} If the value is not a negative safe integer\n */\nexport const asNegativeSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NegativeSafeInt` branded\n * type.\n *\n * The `NegativeSafeInt` type represents a negative safe integer. Division\n * (`div`) uses floor division.\n */\nexport const NegativeSafeInt = {\n  /**\n   * Type guard that checks if a value is a negative safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a negative safe integer, `false` otherwise\n   * @see {@link isNegativeSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NegativeSafeInt` (the lower saturation\n   * target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NegativeSafeInt` (the upper saturation\n   * target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative safe integer.\n   *\n   * The result is non-negative and keeps the `NegativeSafeInt` brand.\n   *\n   * @param a - The negative safe integer value\n   * @returns The absolute value as a non-negative `NegativeSafeInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given negative safe integers.\n   *\n   * @param values - The negative safe integers to compare (at least one required)\n   * @returns The smallest value as a `NegativeSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given negative safe integers.\n   *\n   * @param values - The negative safe integers to compare (at least one required)\n   * @returns The largest value as a `NegativeSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NegativeSafeInt`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNegativeSafeInt`, this is total: out-of-range inputs are clamped\n   * to the nearest representable `NegativeSafeInt` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NegativeSafeInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NegativeSafeInt` 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 `NegativeSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeSafeInt`\n   * (floored to an integer).\n   *\n   * @param a - The base negative safe integer\n   * @param b - The exponent negative safe integer\n   * @returns `a ** b` as a `NegativeSafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two negative safe integers, returning `a + b` as a `NegativeSafeInt`.\n   *\n   * @param a - The first negative safe integer\n   * @param b - The second negative safe integer\n   * @returns The sum of `a` and `b` as a `NegativeSafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two negative safe integers, returning `a - b` as a\n   * `NegativeSafeInt`.\n   *\n   * @param a - The first negative safe integer\n   * @param b - The second negative safe integer\n   * @returns The difference of `a` and `b` as a `NegativeSafeInt`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,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,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAEV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,eAAA,CAAgB,WAAW,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAWjC,MAAM,iBAAA,GAAoB;AAY1B,MAAM,iBAAA,GAAoB;AAS1B,MAAM,eAAA,GAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7B,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,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}
+{"version":3,"file":"negative-safe-int.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAM1D,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,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;IACA,oBAAoB,EAAE,aAAa;IACnC,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,MAAM,CAAC,gBAAgB;IAClC,SAAS,EAAE,CAAC,CAAC;IACb,iBAAiB;CACT,CAAC,CAAC;AAEZ,MAAM,GAAG,GAAG,CAAC,CAA4B,EAAmB,EAAE,CAC5D,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B;;;;;;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;IAEH;;;;;;;OAOG;IACH,GAAG;CACK,CAAC"}

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

@@ -1,158 +1,168 @@
-import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = "a non-negative finite number";
-const {
-  MIN_VALUE,
-  add,
-  castType,
-  div,
-  fromNumber,
-  is,
-  max: max_,
-  min: min_,
-  mul,
-  pow,
-  random,
-  sub
-} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
-  MIN_VALUE: 0,
-  MAX_VALUE: Number.MAX_VALUE,
-  typeNameInMessage
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+const typeNameInMessage = 'a non-negative finite number';
+const { MIN_VALUE, add, castType, div, fromNumber, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+    MIN_VALUE: 0,
+    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 isNonNegativeFiniteNumber = is;
-const asNonNegativeFiniteNumber = castType;
-const NonNegativeFiniteNumber = {
-  /**
-   * Type guard that checks if a value is a non-negative finite number.
-   *
-   * @param value - The value to check
-   * @returns `true` if the value is a non-negative finite number, `false` otherwise
-   * @see {@link isNonNegativeFiniteNumber} for usage examples
-   */
-  is,
-  /**
-   * The smallest value representable as `NonNegativeFiniteNumber` (the lower
-   * saturation target of `fromNumber`).
-   */
-  MIN_VALUE,
-  /**
-   * Returns the smallest of the given non-negative finite numbers.
-   *
-   * @param values - The non-negative finite numbers to compare (at least one required)
-   * @returns The smallest value as a `NonNegativeFiniteNumber`
-   */
-  min: min_,
-  /**
-   * Returns the largest of the given non-negative finite numbers.
-   *
-   * @param values - The non-negative finite numbers to compare (at least one required)
-   * @returns The largest value as a `NonNegativeFiniteNumber`
-   */
-  max: max_,
-  /**
-   * Converts an arbitrary `number` into a `NonNegativeFiniteNumber`, saturating
-   * it into the range `[MIN_VALUE, MAX_VALUE]`.
-   *
-   * Unlike `asNonNegativeFiniteNumber`, this is total: out-of-range inputs are
-   * clamped to the nearest representable `NonNegativeFiniteNumber` instead of
-   * throwing.
-   *
-   * @param value - The value to convert
-   * @returns The value as a `NonNegativeFiniteNumber`
-   */
-  fromNumber,
-  /**
-   * Returns the greatest integer less than or equal to a non-negative finite
-   * number.
-   *
-   * @param a - The non-negative finite number value
-   * @returns The floored value as an integer
-   */
-  floor,
-  /**
-   * Returns the smallest integer greater than or equal to a non-negative finite
-   * number.
-   *
-   * @param a - The non-negative finite number value
-   * @returns The ceiled value as an integer
-   */
-  ceil,
-  /**
-   * Returns the value of a non-negative finite number rounded to the nearest
-   * integer.
-   *
-   * @param a - The non-negative finite number value
-   * @returns The rounded value as an integer
-   */
-  round,
-  /**
-   * Generates a random `NonNegativeFiniteNumber` 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 `NonNegativeFiniteNumber` in `[min, max]`
-   */
-  random,
-  /**
-   * Raises `a` to the power `b`, returning `a ** b` as a
-   * `NonNegativeFiniteNumber`.
-   *
-   * @param a - The base non-negative finite number
-   * @param b - The exponent non-negative finite number
-   * @returns `a ** b` as a `NonNegativeFiniteNumber`
-   */
-  pow,
-  /**
-   * Adds two non-negative finite numbers, returning `a + b` as a
-   * `NonNegativeFiniteNumber`.
-   *
-   * @param a - The first non-negative finite number
-   * @param b - The second non-negative finite number
-   * @returns The sum of `a` and `b` as a `NonNegativeFiniteNumber`
-   */
-  add,
-  /**
-   * Subtracts two non-negative finite numbers, returning `a - b` as a
-   * `NonNegativeFiniteNumber`.
-   *
-   * @param a - The first non-negative finite number
-   * @param b - The second non-negative finite number
-   * @returns The difference of `a` and `b` as a `NonNegativeFiniteNumber`
-   */
-  sub,
-  /**
-   * Multiplies two non-negative finite numbers, returning `a * b` as a
-   * `NonNegativeFiniteNumber`.
-   *
-   * @param a - The first non-negative finite number
-   * @param b - The second non-negative finite number
-   * @returns The product of `a` and `b` as a `NonNegativeFiniteNumber`
-   */
-  mul,
-  /**
-   * Divides two non-negative finite numbers, returning `a / b` as a
-   * `NonNegativeFiniteNumber`.
-   *
-   * @param a - The dividend
-   * @param b - The divisor (must be non-zero)
-   * @returns `a / b` as a `NonNegativeFiniteNumber`
-   */
-  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-negative 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-negative finite number, `false` otherwise
+ */
+export const isNonNegativeFiniteNumber = is;
+/**
+ * Casts a `number` to the `NonNegativeFiniteNumber` branded type.
+ *
+ * Validates that the value is a non-negative finite number and returns it with
+ * the `NonNegativeFiniteNumber` brand. Throws a `TypeError` otherwise.
+ *
+ * @param value - The value to cast
+ * @returns The value as a `NonNegativeFiniteNumber`
+ * @throws {TypeError} If the value is not a non-negative finite number
+ */
+export const asNonNegativeFiniteNumber = castType;
+/**
+ * Namespace providing type-safe operations for the `NonNegativeFiniteNumber`
+ * branded type.
+ *
+ * The `NonNegativeFiniteNumber` type represents a non-negative finite number.
+ */
+export const NonNegativeFiniteNumber = {
+    /**
+     * Type guard that checks if a value is a non-negative finite number.
+     *
+     * @param value - The value to check
+     * @returns `true` if the value is a non-negative finite number, `false` otherwise
+     * @see {@link isNonNegativeFiniteNumber} for usage examples
+     */
+    is,
+    /**
+     * The smallest value representable as `NonNegativeFiniteNumber` (the lower
+     * saturation target of `fromNumber`).
+     */
+    MIN_VALUE,
+    /**
+     * Returns the smallest of the given non-negative finite numbers.
+     *
+     * @param values - The non-negative finite numbers to compare (at least one required)
+     * @returns The smallest value as a `NonNegativeFiniteNumber`
+     */
+    min: min_,
+    /**
+     * Returns the largest of the given non-negative finite numbers.
+     *
+     * @param values - The non-negative finite numbers to compare (at least one required)
+     * @returns The largest value as a `NonNegativeFiniteNumber`
+     */
+    max: max_,
+    /**
+     * Converts an arbitrary `number` into a `NonNegativeFiniteNumber`, saturating
+     * it into the range `[MIN_VALUE, MAX_VALUE]`.
+     *
+     * Unlike `asNonNegativeFiniteNumber`, this is total: out-of-range inputs are
+     * clamped to the nearest representable `NonNegativeFiniteNumber` instead of
+     * throwing.
+     *
+     * @param value - The value to convert
+     * @returns The value as a `NonNegativeFiniteNumber`
+     */
+    fromNumber,
+    /**
+     * Returns the greatest integer less than or equal to a non-negative finite
+     * number.
+     *
+     * @param a - The non-negative finite number value
+     * @returns The floored value as an integer
+     */
+    floor,
+    /**
+     * Returns the smallest integer greater than or equal to a non-negative finite
+     * number.
+     *
+     * @param a - The non-negative finite number value
+     * @returns The ceiled value as an integer
+     */
+    ceil,
+    /**
+     * Returns the value of a non-negative finite number rounded to the nearest
+     * integer.
+     *
+     * @param a - The non-negative finite number value
+     * @returns The rounded value as an integer
+     */
+    round,
+    /**
+     * Generates a random `NonNegativeFiniteNumber` 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 `NonNegativeFiniteNumber` in `[min, max]`
+     */
+    random,
+    /**
+     * Raises `a` to the power `b`, returning `a ** b` as a
+     * `NonNegativeFiniteNumber`.
+     *
+     * @param a - The base non-negative finite number
+     * @param b - The exponent non-negative finite number
+     * @returns `a ** b` as a `NonNegativeFiniteNumber`
+     */
+    pow,
+    /**
+     * Adds two non-negative finite numbers, returning `a + b` as a
+     * `NonNegativeFiniteNumber`.
+     *
+     * @param a - The first non-negative finite number
+     * @param b - The second non-negative finite number
+     * @returns The sum of `a` and `b` as a `NonNegativeFiniteNumber`
+     */
+    add,
+    /**
+     * Subtracts two non-negative finite numbers, returning `a - b` as a
+     * `NonNegativeFiniteNumber`.
+     *
+     * @param a - The first non-negative finite number
+     * @param b - The second non-negative finite number
+     * @returns The difference of `a` and `b` as a `NonNegativeFiniteNumber`
+     */
+    sub,
+    /**
+     * Multiplies two non-negative finite numbers, returning `a * b` as a
+     * `NonNegativeFiniteNumber`.
+     *
+     * @param a - The first non-negative finite number
+     * @param b - The second non-negative finite number
+     * @returns The product of `a` and `b` as a `NonNegativeFiniteNumber`
+     */
+    mul,
+    /**
+     * Divides two non-negative finite numbers, returning `a / b` as a
+     * `NonNegativeFiniteNumber`.
+     *
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns `a / b` as a `NonNegativeFiniteNumber`
+     */
+    div,
 };
 
-export { NonNegativeFiniteNumber, asNonNegativeFiniteNumber, isNonNegativeFiniteNumber };
-//# sourceMappingURL=non-negative-finite-number.mjs.map
+
+//# sourceMappingURL=non-negative-finite-number.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"non-negative-finite-number.mjs","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"sourcesContent":["import {\n  type NonNegativeFiniteNumber as TtfImported_NonNegativeFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeFiniteNumber = TtfImported_NonNegativeFiniteNumber;\n\ntype ElementType = NonNegativeFiniteNumber;\n\nconst typeNameInMessage = 'a non-negative finite number';\n\nconst {\n  MIN_VALUE,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  0,\n  number\n>({\n  MIN_VALUE: 0,\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<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Uint>(\n  '=',\n);\n\n/**\n * Type guard that checks if a value is a non-negative 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-negative finite number, `false` otherwise\n */\nexport const isNonNegativeFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonNegativeFiniteNumber` branded type.\n *\n * Validates that the value is a non-negative finite number and returns it with\n * the `NonNegativeFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeFiniteNumber`\n * @throws {TypeError} If the value is not a non-negative finite number\n */\nexport const asNonNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeFiniteNumber`\n * branded type.\n *\n * The `NonNegativeFiniteNumber` type represents a non-negative finite number.\n */\nexport const NonNegativeFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-negative finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative finite number, `false` otherwise\n   * @see {@link isNonNegativeFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeFiniteNumber` (the lower\n   * saturation target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative finite numbers.\n   *\n   * @param values - The non-negative finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative finite numbers.\n   *\n   * @param values - The non-negative finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonNegativeFiniteNumber`, saturating\n   * it into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asNonNegativeFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `NonNegativeFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonNegativeFiniteNumber`\n   */\n  fromNumber,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-negative finite\n   * number.\n   *\n   * @param a - The non-negative 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-negative finite\n   * number.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-negative finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonNegativeFiniteNumber` 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 `NonNegativeFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The base non-negative finite number\n   * @param b - The exponent non-negative finite number\n   * @returns `a ** b` as a `NonNegativeFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative finite numbers, returning `a + b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The sum of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative finite numbers, returning `a - b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The difference of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative finite numbers, returning `a * b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The product of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative finite numbers, returning `a / b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `NonNegativeFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,CAAA;AAAA,EACX,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;AAeP,MAAM,yBAAA,GAA4B;AAYlC,MAAM,yBAAA,GAA4B;AAQlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,EAAA;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,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,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;AAAA,EAUA,GAAA;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,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}
+{"version":3,"file":"non-negative-finite-number.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,8BAA8B,CAAC;AAEzD,MAAM,EACJ,SAAS,EACT,GAAG,EACH,QAAQ,EACR,GAAG,EACH,UAAU,EACV,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,iBAAiB,CAI3D;IACA,SAAS,EAAE,CAAC;IACZ,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,CACR,GAAG,CACJ,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,QAAQ,CAAC;AAElD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC;;;;;;OAMG;IACH,EAAE;IAEF;;;OAGG;IACH,SAAS;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;;OAUG;IACH,UAAU;IAEV;;;;;;OAMG;IACH,KAAK;IAEL;;;;;;OAMG;IACH,IAAI;IAEJ;;;;;;OAMG;IACH,KAAK;IAEL;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAMR,GAAG,CAAC,CAAC;AAEP,UAAU,CAMR,IAAI,CAAC,CAAC"}