ts-data-forge 14.6.2 → 14.6.3

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

@@ -9,123 +9,123 @@ const { MAX_VALUE, MIN_VALUE, add, castType, fromNumber, is, max: max_, min: min
     typeNameInMessage,
 });
 const abs = (x) => PositiveSafeInt.fromNumber(Math.abs(x));
-/**
- * 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,
 };
 //# sourceMappingURL=negative-safe-int.mjs.map

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

@@ -7,160 +7,160 @@ const { MIN_VALUE, add, castType, div, fromNumber, is, max: max_, min: min_, mul
     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);
 
-/**
- * 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,
 };