ts-data-forge 14.6.2 → 14.6.4

package/dist/number/enum/int8.mjs

@@ -9,11 +9,11 @@ const { MAX_VALUE, MIN_VALUE, castType: castTypeImpl, fromNumber: fromNumberImpl
 });
 const is = (x) => isImpl(x);
 const castType = (x) => 
-// eslint-disable-next-line total-functions/no-unsafe-type-assertion
+
 castTypeImpl(x);
 const fromNumber = (a) => castType(fromNumberImpl(a));
 const abs = (x) => 
-// eslint-disable-next-line total-functions/no-unsafe-type-assertion, @typescript-eslint/no-unnecessary-type-assertion -- unnecessary only under the strict standard library; the stock one types `Math.abs` as returning `number`
+
 Math.abs(x);
 const min_ = (...values) => castType(Math.min(...values));
 const max_ = (...values) => castType(Math.max(...values));
@@ -23,137 +23,137 @@ const sub = (x, y) => fromNumber(x - y);
 const mul = (x, y) => fromNumber(x * y);
 const div = (x, y) => fromNumber(Math.floor(x / y));
 const random = (min, max) => castType(randomImpl(castTypeImpl(min), castTypeImpl(max)));
-/**
- * Type guard that checks if a value is an integer in [-128, 127].
- *
- * Returns `true` for an integer in [-128, 127] — a value with no fractional
- * component.
- *
- * @param value - The value to check
- * @returns `true` if the value is an integer in [-128, 127], `false` otherwise
- */
+
+
+
+
+
+
+
+
+
 export const isInt8 = is;
-/**
- * Casts a `number` to the `Int8` branded type.
- *
- * Validates that the value is an integer in [-128, 127] and returns it with the
- * `Int8` brand. Throws a `TypeError` otherwise.
- *
- * @param value - The value to cast
- * @returns The value as an `Int8`
- * @throws {TypeError} If the value is not an integer in [-128, 127]
- */
+
+
+
+
+
+
+
+
+
+
 export const asInt8 = castType;
-/**
- * Namespace providing type-safe operations for the `Int8` branded type.
- *
- * The `Int8` type represents an integer in [-128, 127]. Division (`div`) uses
- * floor division.
- */
+
+
+
+
+
+
 export const Int8 = {
-    /**
-     * Type guard that checks if a value is an integer in [-128, 127].
-     *
-     * @param value - The value to check
-     * @returns `true` if the value is an integer in [-128, 127], `false` otherwise
-     * @see {@link isInt8} for usage examples
-     */
+
+
+
+
+
+
+
     is,
-    /**
-     * The smallest value representable as `Int8` (the lower saturation target of
-     * `fromNumber`).
-     */
+
+
+
+
     MIN_VALUE,
-    /**
-     * The largest value representable as `Int8` (the upper saturation target of
-     * `fromNumber`).
-     */
+
+
+
+
     MAX_VALUE,
-    /**
-     * Returns the smallest of the given integers.
-     *
-     * @param values - The integers to compare (at least one required)
-     * @returns The smallest value as an `Int8`
-     */
+
+
+
+
+
+
     min: min_,
-    /**
-     * Returns the largest of the given integers.
-     *
-     * @param values - The integers to compare (at least one required)
-     * @returns The largest value as an `Int8`
-     */
+
+
+
+
+
+
     max: max_,
-    /**
-     * Converts an arbitrary `number` into an `Int8`, rounding to the nearest
-     * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
-     *
-     * Unlike `asInt8`, this is total: out-of-range inputs are clamped to the
-     * nearest representable `Int8` instead of throwing.
-     *
-     * @param value - The value to convert
-     * @returns The value as an `Int8`
-     */
+
+
+
+
+
+
+
+
+
+
     fromNumber,
-    /**
-     * Returns the absolute value of an integer in [-128, 127].
-     *
-     * The result is non-negative and keeps the `Int8` brand.
-     *
-     * @param a - The integer value
-     * @returns The absolute value as a non-negative `Int8`
-     */
+
+
+
+
+
+
+
+
     abs,
-    /**
-     * Generates a random `Int8` 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 `Int8` in `[min, max]`
-     */
+
+
+
+
+
+
+
+
+
     random,
-    /**
-     * Raises `a` to the power `b`, returning `a ** b` as an `Int8` (floored to an
-     * integer).
-     *
-     * @param a - The base integer
-     * @param b - The exponent integer
-     * @returns `a ** b` as an `Int8`
-     */
+
+
+
+
+
+
+
+
     pow,
-    /**
-     * Adds two integers, returning `a + b` as an `Int8`.
-     *
-     * @param a - The first integer
-     * @param b - The second integer
-     * @returns The sum of `a` and `b` as an `Int8`
-     */
+
+
+
+
+
+
+
     add,
-    /**
-     * Subtracts two integers, returning `a - b` as an `Int8`.
-     *
-     * @param a - The first integer
-     * @param b - The second integer
-     * @returns The difference of `a` and `b` as an `Int8`
-     */
+
+
+
+
+
+
+
     sub,
-    /**
-     * Multiplies two integers, returning `a * b` as an `Int8`.
-     *
-     * @param a - The first integer
-     * @param b - The second integer
-     * @returns The product of `a` and `b` as an `Int8`
-     */
+
+
+
+
+
+
+
     mul,
-    /**
-     * Divides two integers using floor division (`⌊a / b⌋`): the result is `a /
-     * b` rounded toward negative infinity, as an `Int8`.
-     *
-     * @param a - The dividend
-     * @param b - The divisor (must be non-zero)
-     * @returns The floored quotient as an `Int8`
-     */
+
+
+
+
+
+
+
+
     div,
 };
 

package/dist/number/enum/uint8.mjs

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

package/dist/number/num-arithmetic-types.mjs

@@ -39,5 +39,5 @@
 
 
 
-// #endregion
+
 //# sourceMappingURL=num-arithmetic-types.mjs.map