ts-data-forge 14.6.1 → 14.6.3

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

@@ -1,164 +1,171 @@
-import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = "a positive finite number";
-const {
-  MIN_VALUE,
-  add,
-  castType,
-  div,
-  fromNumber,
-  is,
-  max: max_,
-  min: min_,
-  mul,
-  pow,
-  random,
-  sub
-} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
-  MIN_VALUE: Number.MIN_VALUE,
-  MAX_VALUE: Number.MAX_VALUE,
-  typeNameInMessage
+import { TsDataForgeInternals } from '../refined-number-utils.mjs';
+const typeNameInMessage = 'a positive finite number';
+const { MIN_VALUE, add, castType, div, fromNumber, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+    MIN_VALUE: Number.MIN_VALUE,
+    MAX_VALUE: Number.MAX_VALUE,
+    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
-  )
-);
-const isPositiveFiniteNumber = is;
-const asPositiveFiniteNumber = castType;
-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
+const floor = (x) => 
+
+Math.floor(x);
+const ceil = (x) => 
+
+Math.ceil(x);
+const round = (x) => 
+
+Math.round(x);
+
+
+
+
+
+
+
+
+
+
+
+export const isPositiveFiniteNumber = is;
+
+
+
+
+
+
+
+
+
+
+export const asPositiveFiniteNumber = castType;
+
+
+
+
+
+
+export const PositiveFiniteNumber = {
+
+
+
+
+
+
+
+    is,
+
+
+
+
+
+
+    MIN_VALUE,
+
+
+
+
+
+
+    min: min_,
+
+
+
+
+
+
+    max: max_,
+
+
+
+
+
+
+
+
+
+
+
+    fromNumber,
+
+
+
+
+
+
+
+    floor,
+
+
+
+
+
+
+
+    ceil,
+
+
+
+
+
+
+
+    round,
+
+
+
+
+
+
+
+
+
+    random,
+
+
+
+
+
+
+
+
+    pow,
+
+
+
+
+
+
+
+
+    add,
+
+
+
+
+
+
+
+
+    sub,
+
+
+
+
+
+
+
+
+    mul,
+
+
+
+
+
+
+
+
+    div,
 };
 
-export { PositiveFiniteNumber, asPositiveFiniteNumber, isPositiveFiniteNumber };
-//# sourceMappingURL=positive-finite-number.mjs.map
+
+//# sourceMappingURL=positive-finite-number.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"positive-finite-number.mjs","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"sourcesContent":["import {\n  type PositiveInt,\n  type PositiveFiniteNumber as TtfImported_PositiveFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type PositiveFiniteNumber = TtfImported_PositiveFiniteNumber;\n\ntype ElementType = PositiveFiniteNumber;\n\nconst typeNameInMessage = 'a positive finite number';\n\nconst {\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.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  MIN_VALUE: Number.MIN_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nconst ceil = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(\n    x,\n  ) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  PositiveInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Uint\n>('=');\n\n/**\n * Type guard that checks if a value is a positive finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a positive finite number, `false` otherwise\n */\nexport const isPositiveFiniteNumber = is;\n\n/**\n * Casts a `number` to the `PositiveFiniteNumber` branded type.\n *\n * Validates that the value is a positive finite number and returns it with the\n * `PositiveFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `PositiveFiniteNumber`\n * @throws {TypeError} If the value is not a positive finite number\n */\nexport const asPositiveFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `PositiveFiniteNumber`\n * branded type.\n *\n * The `PositiveFiniteNumber` type represents a positive finite number.\n */\nexport const PositiveFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a positive finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a positive finite number, `false` otherwise\n   * @see {@link isPositiveFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `PositiveFiniteNumber` (the lower\n   * saturation target of `fromNumber`). The domain is open at `0` (excluded),\n   * so this is `Number.MIN_VALUE` — the smallest positive double — rather than\n   * `0`.\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The smallest value as a `PositiveFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given positive finite numbers.\n   *\n   * @param values - The positive finite numbers to compare (at least one required)\n   * @returns The largest value as a `PositiveFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `PositiveFiniteNumber`, saturating it\n   * into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asPositiveFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `PositiveFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `PositiveFiniteNumber`\n   */\n  fromNumber,\n\n  /**\n   * Returns the greatest integer less than or equal to a positive finite\n   * number.\n   *\n   * @param a - The positive finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a positive finite\n   * number.\n   *\n   * @param a - The positive finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a positive finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The positive finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `PositiveFiniteNumber` 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 `PositiveFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The base positive finite number\n   * @param b - The exponent positive finite number\n   * @returns `a ** b` as a `PositiveFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two positive finite numbers, returning `a + b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The sum of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two positive finite numbers, returning `a - b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The difference of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two positive finite numbers, returning `a * b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The first positive finite number\n   * @param b - The second positive finite number\n   * @returns The product of `a` and `b` as a `PositiveFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two positive finite numbers, returning `a / b` as a\n   * `PositiveFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `PositiveFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof PositiveFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'positive'\n  >\n>('=');\n\nexpectType<\n  typeof PositiveFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'positive'>\n>('<=');\n"],"names":[],"mappings":";;AAYA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,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,iBAAA,CAI1C;AAAA,EACA,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAIF,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAyBK,MAAM,sBAAA,GAAyB;AAY/B,MAAM,sBAAA,GAAyB;AAQ/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,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;AAAA,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;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;AAAA,EAUA,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":"positive-finite-number.mjs","sourceRoot":"","sources":["../../../src/number/branded-types/positive-finite-number.mts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAMnE,MAAM,iBAAiB,GAAG,0BAA0B,CAAC;AAErD,MAAM,EACJ,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,iBAAiB,CAI3D;IACA,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;IAC3B,iBAAiB;CACT,CAAC,CAAC;AAEZ,MAAM,KAAK,GAAG,CACZ,CAAc,EAGd,EAAE;AACF,oEAAoE;AACpE,IAAI,CAAC,KAAK,CACR,CAAC,CAGF,CAAC;AAEJ,MAAM,IAAI,GAAG,CACX,CAAc,EAC8C,EAAE;AAC9D,oEAAoE;AACpE,IAAI,CAAC,IAAI,CAAC,CAAC,CAA+D,CAAC;AAE7E,MAAM,KAAK,GAAG,CACZ,CAAc,EAGd,EAAE;AACF,oEAAoE;AACpE,IAAI,CAAC,KAAK,CACR,CAAC,CAGF,CAAC;AAEJ,UAAU,CAGR,GAAG,CAAC,CAAC;AAEP,UAAU,CAKR,GAAG,CAAC,CAAC;AAEP;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAEzC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,QAAQ,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC;;;;;;OAMG;IACH,EAAE;IAEF;;;;;OAKG;IACH,SAAS;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;OAKG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;;OAUG;IACH,UAAU;IAEV;;;;;;OAMG;IACH,KAAK;IAEL;;;;;;OAMG;IACH,IAAI;IAEJ;;;;;;OAMG;IACH,KAAK;IAEL;;;;;;;;OAQG;IACH,MAAM;IAEN;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;IAEH;;;;;;;OAOG;IACH,GAAG;CACK,CAAC;AAEX,UAAU,CAMR,GAAG,CAAC,CAAC;AAEP,UAAU,CAGR,IAAI,CAAC,CAAC"}