ts-data-forge 9.0.0 → 10.0.0

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

@@ -1,155 +1,140 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 import { PositiveFiniteNumber } from './positive-finite-number.mjs';
 
-const typeNameInMessage = 'a negative finite number';
-const { MAX_VALUE, add, castType, clamp, is, max: max_, min: min_, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
-    nonZero: true,
-    MIN_VALUE: -Number.MAX_VALUE,
-    MAX_VALUE: -Number.MIN_VALUE,
-    typeNameInMessage,
+const typeNameInMessage = "a negative finite number";
+const {
+  MAX_VALUE,
+  add,
+  castType,
+  clamp,
+  is,
+  max: max_,
+  min: min_,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat({
+  nonZero: true,
+  MIN_VALUE: -Number.MAX_VALUE,
+  MAX_VALUE: -Number.MIN_VALUE,
+  typeNameInMessage
 });
-/**
- * Returns the absolute value of a negative finite number.
- *
- * The absolute value of a negative finite number is always a positive finite
- * number, so the result is typed as a {@link PositiveFiniteNumber}.
- *
- * @param x - The negative finite number.
- * @returns `|x|` as a PositiveFiniteNumber.
- */
 const abs = (x) => PositiveFiniteNumber.clamp(Math.abs(x));
-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);
-/**
- * Checks if a number is a NegativeFiniteNumber (a finite number `< 0`).
- *
- * @param value The value to check.
- * @returns `true` if the value is a NegativeFiniteNumber, `false` otherwise.
- */
+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 isNegativeFiniteNumber = is;
-/**
- * Casts a number to a NegativeFiniteNumber type.
- *
- * @param value The value to cast.
- * @returns The value as a NegativeFiniteNumber type.
- * @throws {TypeError} If the value is not a negative finite number.
- */
 const asNegativeFiniteNumber = castType;
-/**
- * Namespace providing type-safe arithmetic operations for negative finite
- * numbers.
- *
- * All operations keep results finite (excluding NaN and Infinity). Operations
- * that stay within the negative finite numbers clamp their results to the valid
- * range, while operations whose result leaves the set (`mul`, `div`, `abs`) are
- * typed to reflect the actual sign of the result.
- */
 const NegativeFiniteNumber = {
-    /**
-     * Type guard to check if a value is a NegativeFiniteNumber.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a negative finite number, `false`
-     *   otherwise.
-     */
-    is,
-    /**
-     * The maximum value for a negative finite number.
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the absolute value of a negative finite number.
-     *
-     * @param a The negative finite number.
-     * @returns The absolute value as a PositiveFiniteNumber.
-     */
-    abs,
-    /**
-     * Returns the smaller of two NegativeFiniteNumber values.
-     *
-     * @param a The first NegativeFiniteNumber.
-     * @param b The second NegativeFiniteNumber.
-     * @returns The minimum value as a NegativeFiniteNumber.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two NegativeFiniteNumber values.
-     *
-     * @param a The first NegativeFiniteNumber.
-     * @param b The second NegativeFiniteNumber.
-     * @returns The maximum value as a NegativeFiniteNumber.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the negative finite range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to `(-∞, 0)` as a NegativeFiniteNumber.
-     */
-    clamp,
-    /**
-     * Rounds down a NegativeFiniteNumber to the nearest integer.
-     *
-     * @param x The NegativeFiniteNumber to round down.
-     * @returns The floor value as a NegativeInt (always `<= -1`).
-     */
-    floor,
-    /**
-     * Rounds up a NegativeFiniteNumber to the nearest integer.
-     *
-     * @param x The NegativeFiniteNumber to round up.
-     * @returns The ceiling value as a NonPositiveInt (can be 0).
-     */
-    ceil,
-    /**
-     * Rounds a NegativeFiniteNumber to the nearest integer.
-     *
-     * @param x The NegativeFiniteNumber to round.
-     * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
-     */
-    round,
-    /**
-     * Generates a random NegativeFiniteNumber value.
-     *
-     * @returns A random negative finite number.
-     */
-    random,
-    /**
-     * Raises a NegativeFiniteNumber to the power of another NegativeFiniteNumber.
-     *
-     * @param a The base NegativeFiniteNumber.
-     * @param b The exponent NegativeFiniteNumber.
-     * @returns `a ** b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.
-     */
-    pow,
-    /**
-     * Adds two NegativeFiniteNumber values.
-     *
-     * @param a The first NegativeFiniteNumber.
-     * @param b The second NegativeFiniteNumber.
-     * @returns `a + b` as a NegativeFiniteNumber.
-     */
-    add,
-    /**
-     * Subtracts one NegativeFiniteNumber from another.
-     *
-     * The mathematical result can be positive, so it is clamped to the negative
-     * finite range (maximum `-Number.MIN_VALUE`).
-     *
-     * @param a The minuend NegativeFiniteNumber.
-     * @param b The subtrahend NegativeFiniteNumber.
-     * @returns `a - b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.
-     */
-    sub,
+  /**
+   * Type guard to check if a value is a NegativeFiniteNumber.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a negative finite number, `false`
+   *   otherwise.
+   */
+  is,
+  /**
+   * The maximum value for a negative finite number.
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the absolute value of a negative finite number.
+   *
+   * @param a The negative finite number.
+   * @returns The absolute value as a PositiveFiniteNumber.
+   */
+  abs,
+  /**
+   * Returns the smaller of two NegativeFiniteNumber values.
+   *
+   * @param a The first NegativeFiniteNumber.
+   * @param b The second NegativeFiniteNumber.
+   * @returns The minimum value as a NegativeFiniteNumber.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two NegativeFiniteNumber values.
+   *
+   * @param a The first NegativeFiniteNumber.
+   * @param b The second NegativeFiniteNumber.
+   * @returns The maximum value as a NegativeFiniteNumber.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the negative finite range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   */
+  clamp,
+  /**
+   * Rounds down a NegativeFiniteNumber to the nearest integer.
+   *
+   * @param x The NegativeFiniteNumber to round down.
+   * @returns The floor value as a NegativeInt (always `<= -1`).
+   */
+  floor,
+  /**
+   * Rounds up a NegativeFiniteNumber to the nearest integer.
+   *
+   * @param x The NegativeFiniteNumber to round up.
+   * @returns The ceiling value as a NonPositiveInt (can be 0).
+   */
+  ceil,
+  /**
+   * Rounds a NegativeFiniteNumber to the nearest integer.
+   *
+   * @param x The NegativeFiniteNumber to round.
+   * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).
+   */
+  round,
+  /**
+   * Generates a random NegativeFiniteNumber value.
+   *
+   * @returns A random negative finite number.
+   */
+  random,
+  /**
+   * Raises a NegativeFiniteNumber to the power of another NegativeFiniteNumber.
+   *
+   * @param a The base NegativeFiniteNumber.
+   * @param b The exponent NegativeFiniteNumber.
+   * @returns `a ** b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   */
+  pow,
+  /**
+   * Adds two NegativeFiniteNumber values.
+   *
+   * @param a The first NegativeFiniteNumber.
+   * @param b The second NegativeFiniteNumber.
+   * @returns `a + b` as a NegativeFiniteNumber.
+   */
+  add,
+  /**
+   * Subtracts one NegativeFiniteNumber from another.
+   *
+   * The mathematical result can be positive, so it is clamped to the negative
+   * finite range (maximum `-Number.MIN_VALUE`).
+   *
+   * @param a The minuend NegativeFiniteNumber.
+   * @param b The subtrahend NegativeFiniteNumber.
+   * @returns `a - b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.
+   */
+  sub
 };
 
 export { NegativeFiniteNumber, asNegativeFiniteNumber, isNegativeFiniteNumber };

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

@@ -1 +1 @@
-{"version":3,"file":"negative-finite-number.mjs","sources":["../../../src/number/branded-types/negative-finite-number.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAQA,MAAM,iBAAiB,GAAG,0BAA0B;AAEpD,MAAM,EACJ,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,iBAAiB,CAI3D;AACA,IAAA,OAAO,EAAE,IAAI;AACb,IAAA,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS;AAC5B,IAAA,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS;IAC5B,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;;;AAQG;AACH,MAAM,GAAG,GAAG,CAAC,CAAc,KACzB,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEzC,MAAM,KAAK,GAAG,CACZ,CAAc;AAEd;AACA,IAAI,CAAC,KAAK,CAAC,CAAC,CAA+D;AAE7E,MAAM,IAAI,GAAG,CACX,CAAc;AAId;AACA,IAAI,CAAC,IAAI,CAAC,CAAC,CAEV;AAEH,MAAM,KAAK,GAAG,CACZ,CAAc;AAId;AACA,IAAI,CAAC,KAAK,CACR,CAAC,CAGF;AAEH;;;;;AAKG;AACI,MAAM,sBAAsB,GAAG;AAEtC;;;;;;AAMG;AACI,MAAM,sBAAsB,GAAG;AAEtC;;;;;;;;AAQG;AACI,MAAM,oBAAoB,GAAG;AAClC;;;;;;AAMG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;;AAKG;IACH,GAAG;AAEH;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;;AAKG;IACH,KAAK;AAEL;;;;;AAKG;IACH,IAAI;AAEJ;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;;;;AASG;IACH,GAAG;;;;;"}
+{"version":3,"file":"negative-finite-number.mjs","sources":["../../../src/number/branded-types/negative-finite-number.mts"],"sourcesContent":["import { type NegativeFiniteNumber as TtfImported_NegativeFiniteNumber } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveFiniteNumber } from './positive-finite-number.mjs';\n\nexport type NegativeFiniteNumber = TtfImported_NegativeFiniteNumber;\n\ntype ElementType = NegativeFiniteNumber;\n\nconst typeNameInMessage = 'a negative finite number';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: -Number.MIN_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Returns the absolute value of a negative finite number.\n *\n * The absolute value of a negative finite number is always a positive finite\n * number, so the result is typed as a {@link PositiveFiniteNumber}.\n *\n * @param x - The negative finite number.\n * @returns `|x|` as a PositiveFiniteNumber.\n */\nconst abs = (x: ElementType): PositiveFiniteNumber =>\n  PositiveFiniteNumber.clamp(Math.abs(x));\n\nconst floor = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.floor(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst ceil = (\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.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >;\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\n/**\n * Checks if a number is a NegativeFiniteNumber (a finite number `< 0`).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NegativeFiniteNumber, `false` otherwise.\n */\nexport const isNegativeFiniteNumber = is;\n\n/**\n * Casts a number to a NegativeFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a NegativeFiniteNumber type.\n * @throws {TypeError} If the value is not a negative finite number.\n */\nexport const asNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for negative finite\n * numbers.\n *\n * All operations keep results finite (excluding NaN and Infinity). Operations\n * that stay within the negative finite numbers clamp their results to the valid\n * range, while operations whose result leaves the set (`mul`, `div`, `abs`) are\n * typed to reflect the actual sign of the result.\n */\nexport const NegativeFiniteNumber = {\n  /**\n   * Type guard to check if a value is a NegativeFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a negative finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The maximum value for a negative finite number.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative finite number.\n   *\n   * @param a The negative finite number.\n   * @returns The absolute value as a PositiveFiniteNumber.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two NegativeFiniteNumber values.\n   *\n   * @param a The first NegativeFiniteNumber.\n   * @param b The second NegativeFiniteNumber.\n   * @returns The minimum value as a NegativeFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NegativeFiniteNumber values.\n   *\n   * @param a The first NegativeFiniteNumber.\n   * @param b The second NegativeFiniteNumber.\n   * @returns The maximum value as a NegativeFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the negative finite range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to `(-∞, 0)` as a NegativeFiniteNumber.\n   */\n  clamp,\n\n  /**\n   * Rounds down a NegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NegativeFiniteNumber to round down.\n   * @returns The floor value as a NegativeInt (always `<= -1`).\n   */\n  floor,\n\n  /**\n   * Rounds up a NegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NegativeFiniteNumber to round up.\n   * @returns The ceiling value as a NonPositiveInt (can be 0).\n   */\n  ceil,\n\n  /**\n   * Rounds a NegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NegativeFiniteNumber to round.\n   * @returns The rounded value as a NonPositiveInt (can be 0 if x > -0.5).\n   */\n  round,\n\n  /**\n   * Generates a random NegativeFiniteNumber value.\n   *\n   * @returns A random negative finite number.\n   */\n  random,\n\n  /**\n   * Raises a NegativeFiniteNumber to the power of another NegativeFiniteNumber.\n   *\n   * @param a The base NegativeFiniteNumber.\n   * @param b The exponent NegativeFiniteNumber.\n   * @returns `a ** b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Adds two NegativeFiniteNumber values.\n   *\n   * @param a The first NegativeFiniteNumber.\n   * @param b The second NegativeFiniteNumber.\n   * @returns `a + b` as a NegativeFiniteNumber.\n   */\n  add,\n\n  /**\n   * Subtracts one NegativeFiniteNumber from another.\n   *\n   * The mathematical result can be positive, so it is clamped to the negative\n   * finite range (maximum `-Number.MIN_VALUE`).\n   *\n   * @param a The minuend NegativeFiniteNumber.\n   * @param b The subtrahend NegativeFiniteNumber.\n   * @returns `a - b` clamped to `(-∞, 0)` as a NegativeFiniteNumber.\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAQA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB;AACF,CAAU,CAAA;AAWV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,oBAAA,CAAqB,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAExC,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAIb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAKA,IAAA,CAAK,KAAA;AAAA,IACH;AAAA;AACF,CAAA;AAUK,MAAM,sBAAA,GAAyB;AAS/B,MAAM,sBAAA,GAAyB;AAW/B,MAAM,oBAAA,GAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA;AACF;;;;"}

package/dist/number/branded-types/negative-int.d.mts

@@ -17,16 +17,16 @@ export declare const isNegativeInt: (a: number) => a is TtfImported_NegativeInt;
  * @throws {TypeError} If the value is not a negative integer.
  */
 export declare const asNegativeInt: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
-    readonly ">=0": false;
     readonly "!=0": true;
-    readonly "<=0": true;
     readonly "< 2^15": true;
     readonly "< 2^16": true;
     readonly "< 2^31": true;
     readonly "< 2^32": true;
+    readonly "<=0": true;
+    readonly ">=0": false;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;

package/dist/number/branded-types/negative-int.mjs

@@ -1,124 +1,105 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 import { PositiveInt } from './positive-int.mjs';
 
-const typeNameInMessage = 'a negative integer';
-const { MAX_VALUE, add, castType, clamp, is, max: max_, min: min_, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'Integer',
-    nonZero: true,
-    MIN_VALUE: -Number.MAX_VALUE,
-    MAX_VALUE: -1,
-    typeNameInMessage,
+const typeNameInMessage = "a negative integer";
+const {
+  MAX_VALUE,
+  add,
+  castType,
+  clamp,
+  is,
+  max: max_,
+  min: min_,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "Integer",
+  nonZero: true,
+  MIN_VALUE: -Number.MAX_VALUE,
+  MAX_VALUE: -1,
+  typeNameInMessage
 });
-/**
- * Returns the absolute value of a negative integer.
- *
- * The absolute value of a negative integer is always a positive integer
- * (`>= 1`), so the result is typed as a {@link PositiveInt}.
- *
- * @param x - The negative integer.
- * @returns `|x|` as a PositiveInt.
- */
 const abs = (x) => PositiveInt.clamp(Math.abs(x));
-/**
- * Checks if a number is a NegativeInt (a negative integer `<= -1`).
- *
- * @param value The value to check.
- * @returns `true` if the value is a NegativeInt, `false` otherwise.
- */
 const isNegativeInt = is;
-/**
- * Casts a number to a NegativeInt type.
- *
- * @param value The value to cast.
- * @returns The value as a NegativeInt type.
- * @throws {TypeError} If the value is not a negative integer.
- */
 const asNegativeInt = castType;
-/**
- * Namespace providing type-safe arithmetic operations for negative integers.
- *
- * NegativeInt represents integers that are strictly less than zero (`<= -1`).
- * Operations that stay within the negative integers (such as `add`) clamp their
- * results to the valid range, while operations whose result leaves the set
- * (`mul`, `div`, `abs`) are typed to reflect the actual sign of the result.
- */
 const NegativeInt = {
-    /**
-     * Type guard to check if a value is a NegativeInt.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a negative integer, `false` otherwise.
-     */
-    is,
-    /**
-     * The maximum value for a negative integer.
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the absolute value of a negative integer.
-     *
-     * @param a The negative integer.
-     * @returns The absolute value as a PositiveInt.
-     */
-    abs,
-    /**
-     * Returns the smaller of two negative integers.
-     *
-     * @param a The first negative integer.
-     * @param b The second negative integer.
-     * @returns The minimum value as a NegativeInt.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two negative integers.
-     *
-     * @param a The first negative integer.
-     * @param b The second negative integer.
-     * @returns The maximum value as a NegativeInt.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the negative integer range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to `[-∞, -1]` as a NegativeInt.
-     */
-    clamp,
-    /**
-     * Generates a random NegativeInt value within the valid range.
-     *
-     * @returns A random negative integer.
-     */
-    random,
-    /**
-     * Raises a negative integer to the power of another negative integer.
-     *
-     * @param a The base negative integer.
-     * @param b The exponent negative integer.
-     * @returns `a ** b` clamped to the negative integer range.
-     */
-    pow,
-    /**
-     * Adds two negative integers.
-     *
-     * @param a The first negative integer.
-     * @param b The second negative integer.
-     * @returns `a + b` as a NegativeInt.
-     */
-    add,
-    /**
-     * Subtracts one negative integer from another.
-     *
-     * The mathematical result can be positive, so it is clamped to the negative
-     * integer range (maximum `-1`).
-     *
-     * @param a The minuend negative integer.
-     * @param b The subtrahend negative integer.
-     * @returns `a - b` clamped to the negative integer range.
-     */
-    sub,
+  /**
+   * Type guard to check if a value is a NegativeInt.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a negative integer, `false` otherwise.
+   */
+  is,
+  /**
+   * The maximum value for a negative integer.
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the absolute value of a negative integer.
+   *
+   * @param a The negative integer.
+   * @returns The absolute value as a PositiveInt.
+   */
+  abs,
+  /**
+   * Returns the smaller of two negative integers.
+   *
+   * @param a The first negative integer.
+   * @param b The second negative integer.
+   * @returns The minimum value as a NegativeInt.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two negative integers.
+   *
+   * @param a The first negative integer.
+   * @param b The second negative integer.
+   * @returns The maximum value as a NegativeInt.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the negative integer range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to `[-∞, -1]` as a NegativeInt.
+   */
+  clamp,
+  /**
+   * Generates a random NegativeInt value within the valid range.
+   *
+   * @returns A random negative integer.
+   */
+  random,
+  /**
+   * Raises a negative integer to the power of another negative integer.
+   *
+   * @param a The base negative integer.
+   * @param b The exponent negative integer.
+   * @returns `a ** b` clamped to the negative integer range.
+   */
+  pow,
+  /**
+   * Adds two negative integers.
+   *
+   * @param a The first negative integer.
+   * @param b The second negative integer.
+   * @returns `a + b` as a NegativeInt.
+   */
+  add,
+  /**
+   * Subtracts one negative integer from another.
+   *
+   * The mathematical result can be positive, so it is clamped to the negative
+   * integer range (maximum `-1`).
+   *
+   * @param a The minuend negative integer.
+   * @param b The subtrahend negative integer.
+   * @returns `a - b` clamped to the negative integer range.
+   */
+  sub
 };
 
 export { NegativeInt, asNegativeInt, isNegativeInt };

package/dist/number/branded-types/negative-int.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"negative-int.mjs","sources":["../../../src/number/branded-types/negative-int.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAWA,MAAM,iBAAiB,GAAG,oBAAoB;AAE9C,MAAM,EACJ,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,SAAS;AAC/B,IAAA,OAAO,EAAE,IAAI;AACb,IAAA,SAAS,EAAE,CAAC,MAAM,CAAC,SAAS;IAC5B,SAAS,EAAE,EAAE;IACb,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;;;;AAQG;AACH,MAAM,GAAG,GAAG,CAAC,CAA4B,KACvC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEhC;;;;;AAKG;AACI,MAAM,aAAa,GAAG;AAE7B;;;;;;AAMG;AACI,MAAM,aAAa,GAAG;AAE7B;;;;;;;AAOG;AACI,MAAM,WAAW,GAAG;AACzB;;;;;AAKG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;;AAKG;IACH,GAAG;AAEH;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;;;;AASG;IACH,GAAG;;;;;"}
+{"version":3,"file":"negative-int.mjs","sources":["../../../src/number/branded-types/negative-int.mts"],"sourcesContent":["import {\n  type NegativeInt as TtfImported_NegativeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveInt } from './positive-int.mjs';\n\nexport type NegativeInt = TtfImported_NegativeInt;\n\ntype ElementType = NegativeInt;\n\nconst typeNameInMessage = 'a negative integer';\n\nconst {\n  MAX_VALUE,\n  add,\n  castType,\n  clamp,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  -1\n>({\n  integerOrSafeInteger: 'Integer',\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Returns the absolute value of a negative integer.\n *\n * The absolute value of a negative integer is always a positive integer\n * (`>= 1`), so the result is typed as a {@link PositiveInt}.\n *\n * @param x - The negative integer.\n * @returns `|x|` as a PositiveInt.\n */\nconst abs = (x: WithSmallInt<ElementType>): PositiveInt =>\n  PositiveInt.clamp(Math.abs(x));\n\n/**\n * Checks if a number is a NegativeInt (a negative integer `<= -1`).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NegativeInt, `false` otherwise.\n */\nexport const isNegativeInt = is;\n\n/**\n * Casts a number to a NegativeInt type.\n *\n * @param value The value to cast.\n * @returns The value as a NegativeInt type.\n * @throws {TypeError} If the value is not a negative integer.\n */\nexport const asNegativeInt = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for negative integers.\n *\n * NegativeInt represents integers that are strictly less than zero (`<= -1`).\n * Operations that stay within the negative integers (such as `add`) clamp their\n * results to the valid range, while operations whose result leaves the set\n * (`mul`, `div`, `abs`) are typed to reflect the actual sign of the result.\n */\nexport const NegativeInt = {\n  /**\n   * Type guard to check if a value is a NegativeInt.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a negative integer, `false` otherwise.\n   */\n  is,\n\n  /**\n   * The maximum value for a negative integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative integer.\n   *\n   * @param a The negative integer.\n   * @returns The absolute value as a PositiveInt.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two negative integers.\n   *\n   * @param a The first negative integer.\n   * @param b The second negative integer.\n   * @returns The minimum value as a NegativeInt.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two negative integers.\n   *\n   * @param a The first negative integer.\n   * @param b The second negative integer.\n   * @returns The maximum value as a NegativeInt.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the negative integer range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to `[-∞, -1]` as a NegativeInt.\n   */\n  clamp,\n\n  /**\n   * Generates a random NegativeInt value within the valid range.\n   *\n   * @returns A random negative integer.\n   */\n  random,\n\n  /**\n   * Raises a negative integer to the power of another negative integer.\n   *\n   * @param a The base negative integer.\n   * @param b The exponent negative integer.\n   * @returns `a ** b` clamped to the negative integer range.\n   */\n  pow,\n\n  /**\n   * Adds two negative integers.\n   *\n   * @param a The first negative integer.\n   * @param b The second negative integer.\n   * @returns `a + b` as a NegativeInt.\n   */\n  add,\n\n  /**\n   * Subtracts one negative integer from another.\n   *\n   * The mathematical result can be positive, so it is clamped to the negative\n   * integer range (maximum `-1`).\n   *\n   * @param a The minuend negative integer.\n   * @param b The subtrahend negative integer.\n   * @returns `a - b` clamped to the negative integer range.\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,MAAM,iBAAA,GAAoB,oBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,SAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAWV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,WAAA,CAAY,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAQxB,MAAM,aAAA,GAAgB;AAStB,MAAM,aAAA,GAAgB;AAUtB,MAAM,WAAA,GAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOzB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA;AACF;;;;"}

package/dist/number/branded-types/negative-safe-int.d.mts

@@ -18,16 +18,16 @@ export declare const isNegativeSafeInt: (a: number) => a is TtfImported_Negative
  * @throws {TypeError} If the value is not a negative safe integer.
  */
 export declare const asNegativeSafeInt: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
-    readonly ">=0": false;
     readonly "!=0": true;
-    readonly "<=0": true;
     readonly "< 2^15": true;
     readonly "< 2^16": true;
     readonly "< 2^31": true;
     readonly "< 2^32": true;
+    readonly "<=0": true;
+    readonly ">=0": false;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
     readonly SafeInt: true;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;