ts-data-forge 14.6.2 → 14.6.4

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

@@ -8,113 +8,113 @@ const { MAX_VALUE, MIN_VALUE, add, castType, fromNumber, is, max: max_, min: min
     MAX_VALUE: 2 ** 32 - 1,
     typeNameInMessage,
 });
-/**
- * Type guard that checks if a value is a non-zero integer in [1, 2^32).
- *
- * Returns `true` for a non-zero integer in [1, 2^32) — a value with no
- * fractional component.
- *
- * @param value - The value to check
- * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise
- */
+
+
+
+
+
+
+
+
+
 export const isNonZeroUint32 = is;
-/**
- * Casts a `number` to the `NonZeroUint32` branded type.
- *
- * Validates that the value is a non-zero integer in [1, 2^32) and returns it
- * with the `NonZeroUint32` brand. Throws a `TypeError` otherwise.
- *
- * @param value - The value to cast
- * @returns The value as a `NonZeroUint32`
- * @throws {TypeError} If the value is not a non-zero integer in [1, 2^32)
- */
+
+
+
+
+
+
+
+
+
+
 export const asNonZeroUint32 = castType;
-/**
- * Namespace providing type-safe operations for the `NonZeroUint32` branded
- * type.
- *
- * The `NonZeroUint32` type represents a non-zero integer in [1, 2^32). Division
- * (`div`) uses floor division.
- */
+
+
+
+
+
+
+
 export const NonZeroUint32 = {
-    /**
-     * Type guard that checks if a value is a non-zero integer in [1, 2^32).
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is a non-zero integer in [1, 2^32), `false` otherwise
-     * @see {@link isNonZeroUint32} for usage examples
-     */
+
+
+
+
+
+
+
     is,
-    /**
-     * The smallest value representable as `NonZeroUint32` (the lower saturation
-     * target of `fromNumber`).
-     */
+
+
+
+
     MIN_VALUE,
-    /**
-     * The largest value representable as `NonZeroUint32` (the upper saturation
-     * target of `fromNumber`).
-     */
+
+
+
+
     MAX_VALUE,
-    /**
-     * 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 `NonZeroUint32`
-     */
+
+
+
+
+
+
     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 `NonZeroUint32`
-     */
+
+
+
+
+
+
     max: max_,
-    /**
-     * Converts an arbitrary `number` into a `NonZeroUint32`, rounding to the
-     * nearest integer and saturating the result into the range `[MIN_VALUE,
-     * MAX_VALUE]`.
-     *
-     * Unlike `asNonZeroUint32`, this is total: out-of-range inputs are clamped to
-     * the nearest representable `NonZeroUint32` instead of throwing.
-     *
-     * @param value - The value to convert
-     * @returns The value as a `NonZeroUint32`
-     */
+
+
+
+
+
+
+
+
+
+
+
     fromNumber,
-    /**
-     * Generates a random `NonZeroUint32` 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 `NonZeroUint32` in `[min, max]`
-     */
+
+
+
+
+
+
+
+
+
     random,
-    /**
-     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroUint32`
-     * (floored to an integer).
-     *
-     * @param a - The base non-zero integer
-     * @param b - The exponent non-zero integer
-     * @returns `a ** b` as a `NonZeroUint32`
-     */
+
+
+
+
+
+
+
+
     pow,
-    /**
-     * Adds two non-zero integers, returning `a + b` as a `NonZeroUint32`.
-     *
-     * @param a - The first non-zero integer
-     * @param b - The second non-zero integer
-     * @returns The sum of `a` and `b` as a `NonZeroUint32`
-     */
+
+
+
+
+
+
+
     add,
-    /**
-     * Multiplies two non-zero integers, returning `a * b` as a `NonZeroUint32`.
-     *
-     * @param a - The first non-zero integer
-     * @param b - The second non-zero integer
-     * @returns The product of `a` and `b` as a `NonZeroUint32`
-     */
+
+
+
+
+
+
+
     mul,
 };
 

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

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