ts-data-forge 14.6.2 → 14.6.4

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

@@ -9,152 +9,152 @@ const { MAX_VALUE, add, castType, fromNumber, is, max: max_, min: min_, pow, ran
 });
 const abs = (x) => PositiveFiniteNumber.fromNumber(Math.abs(x));
 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 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 negative finite number, `false` otherwise
- */
+
+
+
+
+
+
+
+
+
 export const isNegativeFiniteNumber = is;
-/**
- * Casts a `number` to the `NegativeFiniteNumber` branded type.
- *
- * Validates that the value is a negative finite number and returns it with the
- * `NegativeFiniteNumber` brand. Throws a `TypeError` otherwise.
- *
- * @param value - The value to cast
- * @returns The value as a `NegativeFiniteNumber`
- * @throws {TypeError} If the value is not a negative finite number
- */
+
+
+
+
+
+
+
+
+
+
 export const asNegativeFiniteNumber = castType;
-/**
- * Namespace providing type-safe operations for the `NegativeFiniteNumber`
- * branded type.
- *
- * The `NegativeFiniteNumber` type represents a negative finite number.
- */
+
+
+
+
+
+
 export const NegativeFiniteNumber = {
-    /**
-     * Type guard that checks if a value is a negative finite number.
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is a negative finite number, `false` otherwise
-     * @see {@link isNegativeFiniteNumber} for usage examples
-     */
+
+
+
+
+
+
+
     is,
-    /**
-     * The largest value representable as `NegativeFiniteNumber` (the upper
-     * saturation target of `fromNumber`). The domain is open at `0` (excluded),
-     * so this is `-Number.MIN_VALUE` — the negative double closest to `0` —
-     * rather than `0`.
-     */
+
+
+
+
+
+
     MAX_VALUE,
-    /**
-     * Returns the absolute value of a negative finite number.
-     *
-     * The result is non-negative and keeps the `NegativeFiniteNumber` brand.
-     *
-     * @param a - The negative finite number value
-     * @returns The absolute value as a non-negative `NegativeFiniteNumber`
-     */
+
+
+
+
+
+
+
+
     abs,
-    /**
-     * Returns the smallest of the given negative finite numbers.
-     *
-     * @param values - The negative finite numbers to compare (at least one required)
-     * @returns The smallest value as a `NegativeFiniteNumber`
-     */
+
+
+
+
+
+
     min: min_,
-    /**
-     * Returns the largest of the given negative finite numbers.
-     *
-     * @param values - The negative finite numbers to compare (at least one required)
-     * @returns The largest value as a `NegativeFiniteNumber`
-     */
+
+
+
+
+
+
     max: max_,
-    /**
-     * Converts an arbitrary `number` into a `NegativeFiniteNumber`, saturating it
-     * into the range `[MIN_VALUE, MAX_VALUE]`.
-     *
-     * Unlike `asNegativeFiniteNumber`, this is total: out-of-range inputs are
-     * clamped to the nearest representable `NegativeFiniteNumber` instead of
-     * throwing.
-     *
-     * @param value - The value to convert
-     * @returns The value as a `NegativeFiniteNumber`
-     */
+
+
+
+
+
+
+
+
+
+
+
     fromNumber,
-    /**
-     * Returns the greatest integer less than or equal to a negative finite
-     * number.
-     *
-     * @param a - The negative finite number value
-     * @returns The floored value as an integer
-     */
+
+
+
+
+
+
+
     floor,
-    /**
-     * Returns the smallest integer greater than or equal to a negative finite
-     * number.
-     *
-     * @param a - The negative finite number value
-     * @returns The ceiled value as an integer
-     */
+
+
+
+
+
+
+
     ceil,
-    /**
-     * Returns the value of a negative finite number rounded to the nearest
-     * integer.
-     *
-     * @param a - The negative finite number value
-     * @returns The rounded value as an integer
-     */
+
+
+
+
+
+
+
     round,
-    /**
-     * Generates a random `NegativeFiniteNumber` 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 `NegativeFiniteNumber` in `[min, max]`
-     */
+
+
+
+
+
+
+
+
+
     random,
-    /**
-     * Raises `a` to the power `b`, returning `a ** b` as a
-     * `NegativeFiniteNumber`.
-     *
-     * @param a - The base negative finite number
-     * @param b - The exponent negative finite number
-     * @returns `a ** b` as a `NegativeFiniteNumber`
-     */
+
+
+
+
+
+
+
+
     pow,
-    /**
-     * Adds two negative finite numbers, returning `a + b` as a
-     * `NegativeFiniteNumber`.
-     *
-     * @param a - The first negative finite number
-     * @param b - The second negative finite number
-     * @returns The sum of `a` and `b` as a `NegativeFiniteNumber`
-     */
+
+
+
+
+
+
+
+
     add,
-    /**
-     * Subtracts two negative finite numbers, returning `a - b` as a
-     * `NegativeFiniteNumber`.
-     *
-     * @param a - The first negative finite number
-     * @param b - The second negative finite number
-     * @returns The difference of `a` and `b` as a `NegativeFiniteNumber`
-     */
+
+
+
+
+
+
+
+
     sub,
 };
 //# sourceMappingURL=negative-finite-number.mjs.map

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

@@ -9,122 +9,122 @@ const { MAX_VALUE, add, castType, fromNumber, is, max: max_, min: min_, pow, ran
     typeNameInMessage,
 });
 const abs = (x) => PositiveInt.fromNumber(Math.abs(x));
-/**
- * Type guard that checks if a value is a negative integer.
- *
- * Returns `true` for a negative integer — a value with no fractional component,
- * including values outside the safe integer range (unlike `SafeInt`).
- *
- * @param value - The value to check
- * @returns `true` if the value is a negative integer, `false` otherwise
- */
+
+
+
+
+
+
+
+
+
 export const isNegativeInt = is;
-/**
- * Casts a `number` to the `NegativeInt` branded type.
- *
- * Validates that the value is a negative integer and returns it with the
- * `NegativeInt` brand. Throws a `TypeError` otherwise.
- *
- * @param value - The value to cast
- * @returns The value as a `NegativeInt`
- * @throws {TypeError} If the value is not a negative integer
- */
+
+
+
+
+
+
+
+
+
+
 export const asNegativeInt = castType;
-/**
- * Namespace providing type-safe operations for the `NegativeInt` branded type.
- *
- * The `NegativeInt` type represents a negative integer. Division (`div`) uses
- * floor division.
- *
- * Unlike `SafeInt`, `NegativeInt` allows values outside the safe integer range
- * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's
- * `number` type.
- */
+
+
+
+
+
+
+
+
+
+
 export const NegativeInt = {
-    /**
-     * Type guard that checks if a value is a negative integer.
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is a negative integer, `false` otherwise
-     * @see {@link isNegativeInt} for usage examples
-     */
+
+
+
+
+
+
+
     is,
-    /**
-     * The largest value representable as `NegativeInt` (the upper saturation
-     * target of `fromNumber`).
-     */
+
+
+
+
     MAX_VALUE,
-    /**
-     * Returns the absolute value of a negative integer.
-     *
-     * The result is non-negative and keeps the `NegativeInt` brand. Note that
-     * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
-     * use `SafeInt` for guaranteed precision.
-     *
-     * @param a - The negative integer value
-     * @returns The absolute value as a non-negative `NegativeInt`
-     */
+
+
+
+
+
+
+
+
+
+
     abs,
-    /**
-     * Returns the smallest of the given negative integers.
-     *
-     * @param values - The negative integers to compare (at least one required)
-     * @returns The smallest value as a `NegativeInt`
-     */
+
+
+
+
+
+
     min: min_,
-    /**
-     * Returns the largest of the given negative integers.
-     *
-     * @param values - The negative integers to compare (at least one required)
-     * @returns The largest value as a `NegativeInt`
-     */
+
+
+
+
+
+
     max: max_,
-    /**
-     * Converts an arbitrary `number` into a `NegativeInt`, rounding to the
-     * nearest integer and saturating the result into the range `[MIN_VALUE,
-     * MAX_VALUE]`.
-     *
-     * Unlike `asNegativeInt`, this is total: out-of-range inputs are clamped to
-     * the nearest representable `NegativeInt` instead of throwing.
-     *
-     * @param value - The value to convert
-     * @returns The value as a `NegativeInt`
-     */
+
+
+
+
+
+
+
+
+
+
+
     fromNumber,
-    /**
-     * Generates a random `NegativeInt` 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 `NegativeInt` in `[min, max]`
-     */
+
+
+
+
+
+
+
+
+
     random,
-    /**
-     * Raises `a` to the power `b`, returning `a ** b` as a `NegativeInt` (floored
-     * to an integer).
-     *
-     * @param a - The base negative integer
-     * @param b - The exponent negative integer
-     * @returns `a ** b` as a `NegativeInt`
-     */
+
+
+
+
+
+
+
+
     pow,
-    /**
-     * Adds two negative integers, returning `a + b` as a `NegativeInt`.
-     *
-     * @param a - The first negative integer
-     * @param b - The second negative integer
-     * @returns The sum of `a` and `b` as a `NegativeInt`
-     */
+
+
+
+
+
+
+
     add,
-    /**
-     * Subtracts two negative integers, returning `a - b` as a `NegativeInt`.
-     *
-     * @param a - The first negative integer
-     * @param b - The second negative integer
-     * @returns The difference of `a` and `b` as a `NegativeInt`
-     */
+
+
+
+
+
+
+
     sub,
 };
 //# sourceMappingURL=negative-int.mjs.map