ts-data-forge 14.6.2 → 14.6.3

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

@@ -7,130 +7,130 @@ const { MAX_VALUE, MIN_VALUE, add, castType, div, fromNumber, is, max: max_, min
     MAX_VALUE: 2 ** 15 - 1,
     typeNameInMessage,
 });
-/**
- * Type guard that checks if a value is a positive integer in [1, 2^15).
- *
- * Returns `true` for a positive integer in [1, 2^15) — a value with no
- * fractional component.
- *
- * @param value - The value to check
- * @returns `true` if the value is a positive integer in [1, 2^15), `false` otherwise
- */
+
+
+
+
+
+
+
+
+
 export const isPositiveInt16 = is;
-/**
- * Casts a `number` to the `PositiveInt16` branded type.
- *
- * Validates that the value is a positive integer in [1, 2^15) and returns it
- * with the `PositiveInt16` brand. Throws a `TypeError` otherwise.
- *
- * @param value - The value to cast
- * @returns The value as a `PositiveInt16`
- * @throws {TypeError} If the value is not a positive integer in [1, 2^15)
- */
+
+
+
+
+
+
+
+
+
+
 export const asPositiveInt16 = castType;
-/**
- * Namespace providing type-safe operations for the `PositiveInt16` branded
- * type.
- *
- * The `PositiveInt16` type represents a positive integer in [1, 2^15). Division
- * (`div`) uses floor division.
- */
+
+
+
+
+
+
+
 export const PositiveInt16 = {
-    /**
-     * Type guard that checks if a value is a positive integer in [1, 2^15).
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is a positive integer in [1, 2^15), `false` otherwise
-     * @see {@link isPositiveInt16} for usage examples
-     */
+
+
+
+
+
+
+
     is,
-    /**
-     * The smallest value representable as `PositiveInt16` (the lower saturation
-     * target of `fromNumber`).
-     */
+
+
+
+
     MIN_VALUE,
-    /**
-     * The largest value representable as `PositiveInt16` (the upper saturation
-     * target of `fromNumber`).
-     */
+
+
+
+
     MAX_VALUE,
-    /**
-     * Returns the smallest of the given positive integers.
-     *
-     * @param values - The positive integers to compare (at least one required)
-     * @returns The smallest value as a `PositiveInt16`
-     */
+
+
+
+
+
+
     min: min_,
-    /**
-     * Returns the largest of the given positive integers.
-     *
-     * @param values - The positive integers to compare (at least one required)
-     * @returns The largest value as a `PositiveInt16`
-     */
+
+
+
+
+
+
     max: max_,
-    /**
-     * Converts an arbitrary `number` into a `PositiveInt16`, rounding to the
-     * nearest integer and saturating the result into the range `[MIN_VALUE,
-     * MAX_VALUE]`.
-     *
-     * Unlike `asPositiveInt16`, this is total: out-of-range inputs are clamped to
-     * the nearest representable `PositiveInt16` instead of throwing.
-     *
-     * @param value - The value to convert
-     * @returns The value as a `PositiveInt16`
-     */
+
+
+
+
+
+
+
+
+
+
+
     fromNumber,
-    /**
-     * Generates a random `PositiveInt16` 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 `PositiveInt16` in `[min, max]`
-     */
+
+
+
+
+
+
+
+
+
     random,
-    /**
-     * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt16`
-     * (floored to an integer).
-     *
-     * @param a - The base positive integer
-     * @param b - The exponent positive integer
-     * @returns `a ** b` as a `PositiveInt16`
-     */
+
+
+
+
+
+
+
+
     pow,
-    /**
-     * Adds two positive integers, returning `a + b` as a `PositiveInt16`.
-     *
-     * @param a - The first positive integer
-     * @param b - The second positive integer
-     * @returns The sum of `a` and `b` as a `PositiveInt16`
-     */
+
+
+
+
+
+
+
     add,
-    /**
-     * Subtracts two positive integers, returning `a - b` as a `PositiveInt16`.
-     *
-     * @param a - The first positive integer
-     * @param b - The second positive integer
-     * @returns The difference of `a` and `b` as a `PositiveInt16`
-     */
+
+
+
+
+
+
+
     sub,
-    /**
-     * Multiplies two positive integers, returning `a * b` as a `PositiveInt16`.
-     *
-     * @param a - The first positive integer
-     * @param b - The second positive integer
-     * @returns The product of `a` and `b` as a `PositiveInt16`
-     */
+
+
+
+
+
+
+
     mul,
-    /**
-     * Divides two positive integers using floor division (`⌊a / b⌋`): the result
-     * is `a / b` rounded toward negative infinity, as a `PositiveInt16`.
-     *
-     * @param a - The dividend
-     * @param b - The divisor (must be non-zero)
-     * @returns The floored quotient as a `PositiveInt16`
-     */
+
+
+
+
+
+
+
+
     div,
 };
 

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

@@ -7,130 +7,130 @@ const { MAX_VALUE, MIN_VALUE, add, castType, div, fromNumber, is, max: max_, min
     MAX_VALUE: 2 ** 31 - 1,
     typeNameInMessage,
 });
-/**
- * Type guard that checks if a value is a positive integer in [1, 2^31).
- *
- * Returns `true` for a positive integer in [1, 2^31) — a value with no
- * fractional component.
- *
- * @param value - The value to check
- * @returns `true` if the value is a positive integer in [1, 2^31), `false` otherwise
- */
+
+
+
+
+
+
+
+
+
 export const isPositiveInt32 = is;
-/**
- * Casts a `number` to the `PositiveInt32` branded type.
- *
- * Validates that the value is a positive integer in [1, 2^31) and returns it
- * with the `PositiveInt32` brand. Throws a `TypeError` otherwise.
- *
- * @param value - The value to cast
- * @returns The value as a `PositiveInt32`
- * @throws {TypeError} If the value is not a positive integer in [1, 2^31)
- */
+
+
+
+
+
+
+
+
+
+
 export const asPositiveInt32 = castType;
-/**
- * Namespace providing type-safe operations for the `PositiveInt32` branded
- * type.
- *
- * The `PositiveInt32` type represents a positive integer in [1, 2^31). Division
- * (`div`) uses floor division.
- */
+
+
+
+
+
+
+
 export const PositiveInt32 = {
-    /**
-     * Type guard that checks if a value is a positive integer in [1, 2^31).
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is a positive integer in [1, 2^31), `false` otherwise
-     * @see {@link isPositiveInt32} for usage examples
-     */
+
+
+
+
+
+
+
     is,
-    /**
-     * The smallest value representable as `PositiveInt32` (the lower saturation
-     * target of `fromNumber`).
-     */
+
+
+
+
     MIN_VALUE,
-    /**
-     * The largest value representable as `PositiveInt32` (the upper saturation
-     * target of `fromNumber`).
-     */
+
+
+
+
     MAX_VALUE,
-    /**
-     * Returns the smallest of the given positive integers.
-     *
-     * @param values - The positive integers to compare (at least one required)
-     * @returns The smallest value as a `PositiveInt32`
-     */
+
+
+
+
+
+
     min: min_,
-    /**
-     * Returns the largest of the given positive integers.
-     *
-     * @param values - The positive integers to compare (at least one required)
-     * @returns The largest value as a `PositiveInt32`
-     */
+
+
+
+
+
+
     max: max_,
-    /**
-     * Converts an arbitrary `number` into a `PositiveInt32`, rounding to the
-     * nearest integer and saturating the result into the range `[MIN_VALUE,
-     * MAX_VALUE]`.
-     *
-     * Unlike `asPositiveInt32`, this is total: out-of-range inputs are clamped to
-     * the nearest representable `PositiveInt32` instead of throwing.
-     *
-     * @param value - The value to convert
-     * @returns The value as a `PositiveInt32`
-     */
+
+
+
+
+
+
+
+
+
+
+
     fromNumber,
-    /**
-     * Generates a random `PositiveInt32` 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 `PositiveInt32` in `[min, max]`
-     */
+
+
+
+
+
+
+
+
+
     random,
-    /**
-     * Raises `a` to the power `b`, returning `a ** b` as a `PositiveInt32`
-     * (floored to an integer).
-     *
-     * @param a - The base positive integer
-     * @param b - The exponent positive integer
-     * @returns `a ** b` as a `PositiveInt32`
-     */
+
+
+
+
+
+
+
+
     pow,
-    /**
-     * Adds two positive integers, returning `a + b` as a `PositiveInt32`.
-     *
-     * @param a - The first positive integer
-     * @param b - The second positive integer
-     * @returns The sum of `a` and `b` as a `PositiveInt32`
-     */
+
+
+
+
+
+
+
     add,
-    /**
-     * Subtracts two positive integers, returning `a - b` as a `PositiveInt32`.
-     *
-     * @param a - The first positive integer
-     * @param b - The second positive integer
-     * @returns The difference of `a` and `b` as a `PositiveInt32`
-     */
+
+
+
+
+
+
+
     sub,
-    /**
-     * Multiplies two positive integers, returning `a * b` as a `PositiveInt32`.
-     *
-     * @param a - The first positive integer
-     * @param b - The second positive integer
-     * @returns The product of `a` and `b` as a `PositiveInt32`
-     */
+
+
+
+
+
+
+
     mul,
-    /**
-     * Divides two positive integers using floor division (`⌊a / b⌋`): the result
-     * is `a / b` rounded toward negative infinity, as a `PositiveInt32`.
-     *
-     * @param a - The dividend
-     * @param b - The divisor (must be non-zero)
-     * @returns The floored quotient as a `PositiveInt32`
-     */
+
+
+
+
+
+
+
+
     div,
 };