ts-data-forge 14.6.0 → 14.6.2

package/dist/number/branded-types/safe-uint.mjs

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

package/dist/number/branded-types/safe-uint.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"safe-uint.mjs","sources":["../../../src/number/branded-types/safe-uint.mts"],"sourcesContent":["import { type SafeUint as TtfImported_SafeUint } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type SafeUint = TtfImported_SafeUint;\n\ntype ElementType = SafeUint;\n\nconst typeNameInMessage = 'a non-negative safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  0,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative safe integer.\n *\n * Returns `true` for a non-negative safe integer — a value with no fractional\n * component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative safe integer, `false` otherwise\n */\nexport const isSafeUint = is;\n\n/**\n * Casts a `number` to the `SafeUint` branded type.\n *\n * Validates that the value is a non-negative safe integer and returns it with\n * the `SafeUint` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `SafeUint`\n * @throws {TypeError} If the value is not a non-negative safe integer\n */\nexport const asSafeUint = castType;\n\n/**\n * Namespace providing type-safe operations for the `SafeUint` branded type.\n *\n * The `SafeUint` type represents a non-negative safe integer. Division (`div`)\n * uses floor division.\n */\nexport const SafeUint = {\n  /**\n   * Type guard that checks if a value is a non-negative safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative safe integer, `false` otherwise\n   * @see {@link isSafeUint} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `SafeUint` (the lower saturation target\n   * of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `SafeUint` (the upper saturation target\n   * of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative safe integers.\n   *\n   * @param values - The non-negative safe integers to compare (at least one required)\n   * @returns The smallest value as a `SafeUint`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative safe integers.\n   *\n   * @param values - The non-negative safe integers to compare (at least one required)\n   * @returns The largest value as a `SafeUint`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `SafeUint`, rounding to the nearest\n   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asSafeUint`, this is total: out-of-range inputs are clamped to the\n   * nearest representable `SafeUint` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `SafeUint`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `SafeUint` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `SafeUint` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `SafeUint` (floored to\n   * an integer).\n   *\n   * @param a - The base non-negative safe integer\n   * @param b - The exponent non-negative safe integer\n   * @returns `a ** b` as a `SafeUint`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative safe integers, returning `a + b` as a `SafeUint`.\n   *\n   * @param a - The first non-negative safe integer\n   * @param b - The second non-negative safe integer\n   * @returns The sum of `a` and `b` as a `SafeUint`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative safe integers, returning `a - b` as a\n   * `SafeUint`.\n   *\n   * @param a - The first non-negative safe integer\n   * @param b - The second non-negative safe integer\n   * @returns The difference of `a` and `b` as a `SafeUint`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative safe integers, returning `a * b` as a\n   * `SafeUint`.\n   *\n   * @param a - The first non-negative safe integer\n   * @param b - The second non-negative safe integer\n   * @returns The product of `a` and `b` as a `SafeUint`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative safe integers using floor division (`⌊a / b⌋`):\n   * the result is `a / b` rounded toward negative infinity, as a `SafeUint`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `SafeUint`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof SafeUint,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof SafeUint,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,6BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA;AAAA,EAEX,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAWH,MAAM,UAAA,GAAa;AAYnB,MAAM,UAAA,GAAa;AAQnB,MAAM,QAAA,GAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQtB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}
+{"version":3,"file":"safe-uint.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/safe-uint.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AAExD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,GAAG,EACH,UAAU,EACV,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;IACA,oBAAoB,EAAE,aAAa;IACnC,SAAS,EAAE,CAAC;IACZ,yGAAyG;IACzG,SAAS,EAAE,MAAM,CAAC,gBAA4B;IAC9C,iBAAiB;CACT,CAAC,CAAC;AAEZ;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAC;AAE7B;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB;;;;;;OAMG;IACH,EAAE;IAEF;;;OAGG;IACH,SAAS;IAET;;;OAGG;IACH,SAAS;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;OASG;IACH,UAAU;IAEV;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;OAMG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAMR,GAAG,CAAC,CAAC;AAEP,UAAU,CAMR,IAAI,CAAC,CAAC"}