ts-data-forge 11.0.0 → 11.0.1

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

@@ -3,19 +3,24 @@ import { PositiveSafeInt } from './positive-safe-int.mjs';
 export type NegativeSafeInt = TtfImported_NegativeSafeInt;
 type ElementType = NegativeSafeInt;
 /**
- * Checks if a number is a NegativeSafeInt (a negative safe integer in the range
- * `[Number.MIN_SAFE_INTEGER, -1]`).
+ * Type guard that checks if a value is a negative safe integer.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NegativeSafeInt, `false` otherwise.
+ * Returns `true` for a negative safe integer — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a negative safe integer, `false` otherwise
  */
 export declare const isNegativeSafeInt: (a: number) => a is TtfImported_NegativeSafeInt;
 /**
- * Casts a number to a NegativeSafeInt type.
+ * Casts a `number` to the `NegativeSafeInt` branded type.
+ *
+ * Validates that the value is a negative safe integer and returns it with the
+ * `NegativeSafeInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NegativeSafeInt type.
- * @throws {TypeError} If the value is not a negative safe integer.
+ * @param value - The value to cast
+ * @returns The value as a `NegativeSafeInt`
+ * @throws {TypeError} If the value is not a negative safe integer
  */
 export declare const asNegativeSafeInt: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -33,98 +38,94 @@ export declare const asNegativeSafeInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for negative safe
- * integers.
+ * Namespace providing type-safe operations for the `NegativeSafeInt` branded
+ * type.
  *
- * NegativeSafeInt represents safe integers that are strictly less than zero
- * (`[Number.MIN_SAFE_INTEGER, -1]`). Operations that stay within the negative
- * safe integers 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.
+ * The `NegativeSafeInt` type represents a negative safe integer. Division
+ * (`div`) uses floor division.
  */
 export declare const NegativeSafeInt: {
     /**
-     * Type guard to check if a value is a NegativeSafeInt.
+     * Type guard that checks if a value is a negative safe integer.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a negative safe integer, `false` otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a negative safe integer, `false` otherwise
+     * @see {@link isNegativeSafeInt} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NegativeSafeInt;
     /**
-     * The minimum value for a negative safe integer.
-     *
-     * @readonly
+     * The smallest value representable as `NegativeSafeInt`.
      */
     readonly MIN_VALUE: number;
     /**
-     * The maximum value for a negative safe integer.
-     *
-     * @readonly
+     * The largest value representable as `NegativeSafeInt`.
      */
     readonly MAX_VALUE: -1;
     /**
      * Returns the absolute value of a negative safe integer.
      *
-     * @param a The negative safe integer.
-     * @returns The absolute value as a PositiveSafeInt.
+     * The result is non-negative and keeps the `NegativeSafeInt` brand.
+     *
+     * @param a - The negative safe integer value
+     * @returns The absolute value as a non-negative `NegativeSafeInt`
      */
     readonly abs: (x: WithSmallInt<ElementType>) => PositiveSafeInt;
     /**
-     * Returns the smaller of two negative safe integers.
+     * Returns the smallest of the given negative safe integers.
      *
-     * @param a The first negative safe integer.
-     * @param b The second negative safe integer.
-     * @returns The minimum value as a NegativeSafeInt.
+     * @param values - The negative safe integers to compare (at least one required)
+     * @returns The smallest value as a `NegativeSafeInt`
      */
     readonly min: (...values: readonly WithSmallInt<TtfImported_NegativeSafeInt>[]) => TtfImported_NegativeSafeInt;
     /**
-     * Returns the larger of two negative safe integers.
+     * Returns the largest of the given negative safe integers.
      *
-     * @param a The first negative safe integer.
-     * @param b The second negative safe integer.
-     * @returns The maximum value as a NegativeSafeInt.
+     * @param values - The negative safe integers to compare (at least one required)
+     * @returns The largest value as a `NegativeSafeInt`
      */
     readonly max: (...values: readonly WithSmallInt<TtfImported_NegativeSafeInt>[]) => TtfImported_NegativeSafeInt;
     /**
-     * Clamps a number to the NegativeSafeInt range.
+     * Clamps a `number` into the `NegativeSafeInt` range, rounding to the nearest
+     * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to `[Number.MIN_SAFE_INTEGER, -1]` as a
-     *   NegativeSafeInt.
+     * @param value - The value to clamp
+     * @returns The clamped value as a `NegativeSafeInt`
      */
     readonly clamp: (x: number) => TtfImported_NegativeSafeInt;
     /**
-     * Generates a random NegativeSafeInt value within the valid range.
+     * Generates a random `NegativeSafeInt` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random NegativeSafeInt between Number.MIN_SAFE_INTEGER and -1.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NegativeSafeInt` in `[min, max]`
      */
     readonly random: (min?: WithSmallInt<TtfImported_NegativeSafeInt> | undefined, max?: WithSmallInt<TtfImported_NegativeSafeInt> | undefined) => TtfImported_NegativeSafeInt;
     /**
-     * Raises a negative safe integer to the power of another negative safe
-     * integer.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NegativeSafeInt`
+     * (floored to an integer).
      *
-     * @param a The base negative safe integer.
-     * @param b The exponent negative safe integer.
-     * @returns `a ** b` clamped to the NegativeSafeInt range.
+     * @param a - The base negative safe integer
+     * @param b - The exponent negative safe integer
+     * @returns `a ** b` as a `NegativeSafeInt`
      */
     readonly pow: (x: WithSmallInt<TtfImported_NegativeSafeInt>, y: WithSmallInt<TtfImported_NegativeSafeInt>) => TtfImported_NegativeSafeInt;
     /**
-     * Adds two negative safe integers.
+     * Adds two negative safe integers, returning `a + b` as a `NegativeSafeInt`.
      *
-     * @param a The first negative safe integer.
-     * @param b The second negative safe integer.
-     * @returns `a + b` clamped to the NegativeSafeInt range.
+     * @param a - The first negative safe integer
+     * @param b - The second negative safe integer
+     * @returns The sum of `a` and `b` as a `NegativeSafeInt`
      */
     readonly add: (x: WithSmallInt<TtfImported_NegativeSafeInt>, y: WithSmallInt<TtfImported_NegativeSafeInt>) => TtfImported_NegativeSafeInt;
     /**
-     * Subtracts one negative safe integer from another.
-     *
-     * The mathematical result can be positive, so it is clamped to the
-     * NegativeSafeInt range (maximum `-1`).
+     * Subtracts two negative safe integers, returning `a - b` as a
+     * `NegativeSafeInt`.
      *
-     * @param a The minuend negative safe integer.
-     * @param b The subtrahend negative safe integer.
-     * @returns `a - b` clamped to the NegativeSafeInt range.
+     * @param a - The first negative safe integer
+     * @param b - The second negative safe integer
+     * @returns The difference of `a` and `b` as a `NegativeSafeInt`
      */
     readonly sub: (x: WithSmallInt<TtfImported_NegativeSafeInt>, y: WithSmallInt<TtfImported_NegativeSafeInt>) => TtfImported_NegativeSafeInt;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"negative-safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,IAAI,2BAA2B,EACnD,KAAK,YAAY,EAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,MAAM,eAAe,GAAG,2BAA2B,CAAC;AAE1D,KAAK,WAAW,GAAG,eAAe,CAAC;AAwCnC;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,iDAAK,CAAC;AAEpC;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;MAAW,CAAC;AAE1C;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;IAC1B;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;sBA3DW,YAAY,CAAC,WAAW,CAAC,KAAG,eAAe;IA8DzD;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;OASG;;CAEK,CAAC"}
+{"version":3,"file":"negative-safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,eAAe,IAAI,2BAA2B,EACnD,KAAK,YAAY,EAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,MAAM,eAAe,GAAG,2BAA2B,CAAC;AAE1D,KAAK,WAAW,GAAG,eAAe,CAAC;AA+BnC;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,iDAAK,CAAC;AAEpC;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;MAAW,CAAC;AAE1C;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;IAC1B;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;;;;OAOG;sBA5DW,YAAY,CAAC,WAAW,CAAC,KAAG,eAAe;IA+DzD;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}

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

@@ -26,87 +26,86 @@ const isNegativeSafeInt = is;
 const asNegativeSafeInt = castType;
 const NegativeSafeInt = {
   /**
-   * Type guard to check if a value is a NegativeSafeInt.
+   * Type guard that checks if a value is a negative safe integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a negative safe integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a negative safe integer, `false` otherwise
+   * @see {@link isNegativeSafeInt} for usage examples
    */
   is,
   /**
-   * The minimum value for a negative safe integer.
-   *
-   * @readonly
+   * The smallest value representable as `NegativeSafeInt`.
    */
   MIN_VALUE,
   /**
-   * The maximum value for a negative safe integer.
-   *
-   * @readonly
+   * The largest value representable as `NegativeSafeInt`.
    */
   MAX_VALUE,
   /**
    * Returns the absolute value of a negative safe integer.
    *
-   * @param a The negative safe integer.
-   * @returns The absolute value as a PositiveSafeInt.
+   * The result is non-negative and keeps the `NegativeSafeInt` brand.
+   *
+   * @param a - The negative safe integer value
+   * @returns The absolute value as a non-negative `NegativeSafeInt`
    */
   abs,
   /**
-   * Returns the smaller of two negative safe integers.
+   * Returns the smallest of the given negative safe integers.
    *
-   * @param a The first negative safe integer.
-   * @param b The second negative safe integer.
-   * @returns The minimum value as a NegativeSafeInt.
+   * @param values - The negative safe integers to compare (at least one required)
+   * @returns The smallest value as a `NegativeSafeInt`
    */
   min: min_,
   /**
-   * Returns the larger of two negative safe integers.
+   * Returns the largest of the given negative safe integers.
    *
-   * @param a The first negative safe integer.
-   * @param b The second negative safe integer.
-   * @returns The maximum value as a NegativeSafeInt.
+   * @param values - The negative safe integers to compare (at least one required)
+   * @returns The largest value as a `NegativeSafeInt`
    */
   max: max_,
   /**
-   * Clamps a number to the NegativeSafeInt range.
+   * Clamps a `number` into the `NegativeSafeInt` range, rounding to the nearest
+   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to `[Number.MIN_SAFE_INTEGER, -1]` as a
-   *   NegativeSafeInt.
+   * @param value - The value to clamp
+   * @returns The clamped value as a `NegativeSafeInt`
    */
   clamp,
   /**
-   * Generates a random NegativeSafeInt value within the valid range.
+   * Generates a random `NegativeSafeInt` within the given range.
    *
-   * @returns A random NegativeSafeInt between Number.MIN_SAFE_INTEGER and -1.
+   * The range is inclusive on both ends.
+   *
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NegativeSafeInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a negative safe integer to the power of another negative safe
-   * integer.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeSafeInt`
+   * (floored to an integer).
    *
-   * @param a The base negative safe integer.
-   * @param b The exponent negative safe integer.
-   * @returns `a ** b` clamped to the NegativeSafeInt range.
+   * @param a - The base negative safe integer
+   * @param b - The exponent negative safe integer
+   * @returns `a ** b` as a `NegativeSafeInt`
    */
   pow,
   /**
-   * Adds two negative safe integers.
+   * Adds two negative safe integers, returning `a + b` as a `NegativeSafeInt`.
    *
-   * @param a The first negative safe integer.
-   * @param b The second negative safe integer.
-   * @returns `a + b` clamped to the NegativeSafeInt range.
+   * @param a - The first negative safe integer
+   * @param b - The second negative safe integer
+   * @returns The sum of `a` and `b` as a `NegativeSafeInt`
    */
   add,
   /**
-   * Subtracts one negative safe integer from another.
-   *
-   * The mathematical result can be positive, so it is clamped to the
-   * NegativeSafeInt range (maximum `-1`).
+   * Subtracts two negative safe integers, returning `a - b` as a
+   * `NegativeSafeInt`.
    *
-   * @param a The minuend negative safe integer.
-   * @param b The subtrahend negative safe integer.
-   * @returns `a - b` clamped to the NegativeSafeInt range.
+   * @param a - The first negative safe integer
+   * @param b - The second negative safe integer
+   * @returns The difference of `a` and `b` as a `NegativeSafeInt`
    */
   sub
 };

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

@@ -1 +1 @@
-{"version":3,"file":"negative-safe-int.mjs","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"sourcesContent":["import {\n  type NegativeSafeInt as TtfImported_NegativeSafeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveSafeInt } from './positive-safe-int.mjs';\n\nexport type NegativeSafeInt = TtfImported_NegativeSafeInt;\n\ntype ElementType = NegativeSafeInt;\n\nconst typeNameInMessage = 'a negative safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_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: 'SafeInteger',\n  nonZero: true,\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\n/**\n * Returns the absolute value of a negative safe integer.\n *\n * The absolute value of a negative safe integer is always a positive safe\n * integer (`>= 1`), so the result is typed as a {@link PositiveSafeInt}.\n *\n * @param x - The negative safe integer.\n * @returns `|x|` as a PositiveSafeInt.\n */\nconst abs = (x: WithSmallInt<ElementType>): PositiveSafeInt =>\n  PositiveSafeInt.clamp(Math.abs(x));\n\n/**\n * Checks if a number is a NegativeSafeInt (a negative safe integer in the range\n * `[Number.MIN_SAFE_INTEGER, -1]`).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NegativeSafeInt, `false` otherwise.\n */\nexport const isNegativeSafeInt = is;\n\n/**\n * Casts a number to a NegativeSafeInt type.\n *\n * @param value The value to cast.\n * @returns The value as a NegativeSafeInt type.\n * @throws {TypeError} If the value is not a negative safe integer.\n */\nexport const asNegativeSafeInt = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for negative safe\n * integers.\n *\n * NegativeSafeInt represents safe integers that are strictly less than zero\n * (`[Number.MIN_SAFE_INTEGER, -1]`). Operations that stay within the negative\n * safe integers clamp their results to the valid range, while operations whose\n * result leaves the set (`mul`, `div`, `abs`) are typed to reflect the actual\n * sign of the result.\n */\nexport const NegativeSafeInt = {\n  /**\n   * Type guard to check if a value is a NegativeSafeInt.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a negative safe integer, `false` otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a negative safe integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a negative safe integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative safe integer.\n   *\n   * @param a The negative safe integer.\n   * @returns The absolute value as a PositiveSafeInt.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two negative safe integers.\n   *\n   * @param a The first negative safe integer.\n   * @param b The second negative safe integer.\n   * @returns The minimum value as a NegativeSafeInt.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two negative safe integers.\n   *\n   * @param a The first negative safe integer.\n   * @param b The second negative safe integer.\n   * @returns The maximum value as a NegativeSafeInt.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the NegativeSafeInt range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to `[Number.MIN_SAFE_INTEGER, -1]` as a\n   *   NegativeSafeInt.\n   */\n  clamp,\n\n  /**\n   * Generates a random NegativeSafeInt value within the valid range.\n   *\n   * @returns A random NegativeSafeInt between Number.MIN_SAFE_INTEGER and -1.\n   */\n  random,\n\n  /**\n   * Raises a negative safe integer to the power of another negative safe\n   * integer.\n   *\n   * @param a The base negative safe integer.\n   * @param b The exponent negative safe integer.\n   * @returns `a ** b` clamped to the NegativeSafeInt range.\n   */\n  pow,\n\n  /**\n   * Adds two negative safe integers.\n   *\n   * @param a The first negative safe integer.\n   * @param b The second negative safe integer.\n   * @returns `a + b` clamped to the NegativeSafeInt range.\n   */\n  add,\n\n  /**\n   * Subtracts one negative safe integer from another.\n   *\n   * The mathematical result can be positive, so it is clamped to the\n   * NegativeSafeInt range (maximum `-1`).\n   *\n   * @param a The minuend negative safe integer.\n   * @param b The subtrahend negative safe integer.\n   * @returns `a - b` clamped to the NegativeSafeInt range.\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,MAAM,iBAAA,GAAoB,yBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,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,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAWV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,eAAA,CAAgB,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAS5B,MAAM,iBAAA,GAAoB;AAS1B,MAAM,iBAAA,GAAoB;AAY1B,MAAM,eAAA,GAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO7B,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;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;AAAA,EASL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,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;AAAA;AAAA,EAYA;AACF;;;;"}
+{"version":3,"file":"negative-safe-int.mjs","sources":["../../../src/number/branded-types/negative-safe-int.mts"],"sourcesContent":["import {\n  type NegativeSafeInt as TtfImported_NegativeSafeInt,\n  type WithSmallInt,\n} from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\nimport { PositiveSafeInt } from './positive-safe-int.mjs';\n\nexport type NegativeSafeInt = TtfImported_NegativeSafeInt;\n\ntype ElementType = NegativeSafeInt;\n\nconst typeNameInMessage = 'a negative safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_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: 'SafeInteger',\n  nonZero: true,\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: -1,\n  typeNameInMessage,\n} as const);\n\nconst abs = (x: WithSmallInt<ElementType>): PositiveSafeInt =>\n  PositiveSafeInt.clamp(Math.abs(x));\n\n/**\n * Type guard that checks if a value is a negative safe integer.\n *\n * Returns `true` for a 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 negative safe integer, `false` otherwise\n */\nexport const isNegativeSafeInt = is;\n\n/**\n * Casts a `number` to the `NegativeSafeInt` branded type.\n *\n * Validates that the value is a negative safe integer and returns it with the\n * `NegativeSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NegativeSafeInt`\n * @throws {TypeError} If the value is not a negative safe integer\n */\nexport const asNegativeSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NegativeSafeInt` branded\n * type.\n *\n * The `NegativeSafeInt` type represents a negative safe integer. Division\n * (`div`) uses floor division.\n */\nexport const NegativeSafeInt = {\n  /**\n   * Type guard that checks if a value is a negative safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a negative safe integer, `false` otherwise\n   * @see {@link isNegativeSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NegativeSafeInt`.\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NegativeSafeInt`.\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the absolute value of a negative safe integer.\n   *\n   * The result is non-negative and keeps the `NegativeSafeInt` brand.\n   *\n   * @param a - The negative safe integer value\n   * @returns The absolute value as a non-negative `NegativeSafeInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given negative safe integers.\n   *\n   * @param values - The negative safe integers to compare (at least one required)\n   * @returns The smallest value as a `NegativeSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given negative safe integers.\n   *\n   * @param values - The negative safe integers to compare (at least one required)\n   * @returns The largest value as a `NegativeSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Clamps a `number` into the `NegativeSafeInt` range, rounding to the nearest\n   * integer and constraining the result to `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * @param value - The value to clamp\n   * @returns The clamped value as a `NegativeSafeInt`\n   */\n  clamp,\n\n  /**\n   * Generates a random `NegativeSafeInt` 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 `NegativeSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NegativeSafeInt`\n   * (floored to an integer).\n   *\n   * @param a - The base negative safe integer\n   * @param b - The exponent negative safe integer\n   * @returns `a ** b` as a `NegativeSafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two negative safe integers, returning `a + b` as a `NegativeSafeInt`.\n   *\n   * @param a - The first negative safe integer\n   * @param b - The second negative safe integer\n   * @returns The sum of `a` and `b` as a `NegativeSafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two negative safe integers, returning `a - b` as a\n   * `NegativeSafeInt`.\n   *\n   * @param a - The first negative safe integer\n   * @param b - The second negative safe integer\n   * @returns The difference of `a` and `b` as a `NegativeSafeInt`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;;AAWA,MAAM,iBAAA,GAAoB,yBAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,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,aAAA;AAAA,EACtB,OAAA,EAAS,IAAA;AAAA,EACT,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,EAAA;AAAA,EACX;AACF,CAAU,CAAA;AAEV,MAAM,GAAA,GAAM,CAAC,CAAA,KACX,eAAA,CAAgB,MAAM,IAAA,CAAK,GAAA,CAAI,CAAC,CAAC,CAAA;AAW5B,MAAM,iBAAA,GAAoB;AAY1B,MAAM,iBAAA,GAAoB;AAS1B,MAAM,eAAA,GAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7B,EAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;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,EASL,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,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}

package/dist/number/branded-types/non-negative-finite-number.d.mts

@@ -3,18 +3,24 @@ import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 export type NonNegativeFiniteNumber = TtfImported_NonNegativeFiniteNumber;
 type ElementType = NonNegativeFiniteNumber;
 /**
- * Checks if a number is a NonNegativeFiniteNumber (a finite number >= 0).
+ * Type guard that checks if a value is a non-negative finite number.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonNegativeFiniteNumber, `false` otherwise.
+ * Returns `true` only for a finite value — never `NaN`, `Infinity`, or
+ * `-Infinity`.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative finite number, `false` otherwise
  */
 export declare const isNonNegativeFiniteNumber: (a: number) => a is TtfImported_NonNegativeFiniteNumber;
 /**
- * Casts a number to a NonNegativeFiniteNumber type.
+ * Casts a `number` to the `NonNegativeFiniteNumber` branded type.
+ *
+ * Validates that the value is a non-negative finite number and returns it with
+ * the `NonNegativeFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonNegativeFiniteNumber type.
- * @throws {TypeError} If the value is not a non-negative finite number.
+ * @param value - The value to cast
+ * @returns The value as a `NonNegativeFiniteNumber`
+ * @throws {TypeError} If the value is not a non-negative finite number
  */
 export declare const asNonNegativeFiniteNumber: <N extends number>(x: N) => number & {
     readonly "> -2^16": true;
@@ -28,119 +34,123 @@ export declare const asNonNegativeFiniteNumber: <N extends number>(x: N) => numb
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for non-negative finite
- * numbers.
+ * Namespace providing type-safe operations for the `NonNegativeFiniteNumber`
+ * branded type.
  *
- * All operations maintain the non-negative constraint by clamping negative
- * results to 0, while ensuring results remain finite (excluding NaN and
- * Infinity). This type is useful for representing measurements, distances,
- * weights, and other inherently non-negative values.
+ * The `NonNegativeFiniteNumber` type represents a non-negative finite number.
  */
 export declare const NonNegativeFiniteNumber: {
     /**
-     * Type guard to check if a value is a NonNegativeFiniteNumber.
+     * Type guard that checks if a value is a non-negative finite number.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-negative finite number, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-negative finite number, `false` otherwise
+     * @see {@link isNonNegativeFiniteNumber} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonNegativeFiniteNumber;
     /**
-     * The minimum value for a non-negative finite number.
-     *
-     * @readonly
+     * The smallest value representable as `NonNegativeFiniteNumber`.
      */
     readonly MIN_VALUE: 0;
     /**
-     * Returns the smaller of two NonNegativeFiniteNumber values.
+     * Returns the smallest of the given non-negative finite numbers.
      *
-     * @param a The first NonNegativeFiniteNumber.
-     * @param b The second NonNegativeFiniteNumber.
-     * @returns The minimum value as a NonNegativeFiniteNumber.
+     * @param values - The non-negative finite numbers to compare (at least one required)
+     * @returns The smallest value as a `NonNegativeFiniteNumber`
      */
     readonly min: (...values: readonly TtfImported_NonNegativeFiniteNumber[]) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * Returns the larger of two NonNegativeFiniteNumber values.
+     * Returns the largest of the given non-negative finite numbers.
      *
-     * @param a The first NonNegativeFiniteNumber.
-     * @param b The second NonNegativeFiniteNumber.
-     * @returns The maximum value as a NonNegativeFiniteNumber.
+     * @param values - The non-negative finite numbers to compare (at least one required)
+     * @returns The largest value as a `NonNegativeFiniteNumber`
      */
     readonly max: (...values: readonly TtfImported_NonNegativeFiniteNumber[]) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * Clamps a number to the non-negative finite range.
+     * Clamps a `number` into the `NonNegativeFiniteNumber` range `[MIN_VALUE,
+     * MAX_VALUE]`.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, +∞) as a NonNegativeFiniteNumber.
+     * @param value - The value to clamp
+     * @returns The clamped value as a `NonNegativeFiniteNumber`
      */
     readonly clamp: (x: number) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * Rounds down a NonNegativeFiniteNumber to the nearest integer.
+     * Returns the greatest integer less than or equal to a non-negative finite
+     * number.
      *
-     * @param x The NonNegativeFiniteNumber to round down.
-     * @returns The floor value as a Uint.
+     * @param a - The non-negative finite number value
+     * @returns The floored value as an integer
      */
     readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Rounds up a NonNegativeFiniteNumber to the nearest integer.
+     * Returns the smallest integer greater than or equal to a non-negative finite
+     * number.
      *
-     * @param x The NonNegativeFiniteNumber to round up.
-     * @returns The ceiling value as a Uint.
+     * @param a - The non-negative finite number value
+     * @returns The ceiled value as an integer
      */
     readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Rounds a NonNegativeFiniteNumber to the nearest integer.
+     * Returns the value of a non-negative finite number rounded to the nearest
+     * integer.
      *
-     * @param x The NonNegativeFiniteNumber to round.
-     * @returns The rounded value as a Uint.
+     * @param a - The non-negative finite number value
+     * @returns The rounded value as an integer
      */
     readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Generates a random NonNegativeFiniteNumber value.
+     * Generates a random `NonNegativeFiniteNumber` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random non-negative finite number.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonNegativeFiniteNumber` in `[min, max]`
      */
     readonly random: (min?: TtfImported_NonNegativeFiniteNumber | undefined, max?: TtfImported_NonNegativeFiniteNumber | undefined) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * Raises a NonNegativeFiniteNumber to the power of another
-     * NonNegativeFiniteNumber.
+     * Raises `a` to the power `b`, returning `a ** b` as a
+     * `NonNegativeFiniteNumber`.
      *
-     * @param a The base NonNegativeFiniteNumber.
-     * @param b The exponent NonNegativeFiniteNumber.
-     * @returns `a ** b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+     * @param a - The base non-negative finite number
+     * @param b - The exponent non-negative finite number
+     * @returns `a ** b` as a `NonNegativeFiniteNumber`
      */
     readonly pow: (x: TtfImported_NonNegativeFiniteNumber, y: TtfImported_NonNegativeFiniteNumber) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * Adds two NonNegativeFiniteNumber values.
+     * Adds two non-negative finite numbers, returning `a + b` as a
+     * `NonNegativeFiniteNumber`.
      *
-     * @param a The first NonNegativeFiniteNumber.
-     * @param b The second NonNegativeFiniteNumber.
-     * @returns `a + b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+     * @param a - The first non-negative finite number
+     * @param b - The second non-negative finite number
+     * @returns The sum of `a` and `b` as a `NonNegativeFiniteNumber`
      */
     readonly add: (x: TtfImported_NonNegativeFiniteNumber, y: TtfImported_NonNegativeFiniteNumber) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * Subtracts one NonNegativeFiniteNumber from another.
+     * Subtracts two non-negative finite numbers, returning `a - b` as a
+     * `NonNegativeFiniteNumber`.
      *
-     * @param a The minuend NonNegativeFiniteNumber.
-     * @param b The subtrahend NonNegativeFiniteNumber.
-     * @returns `a - b` clamped to [0, +∞) as a NonNegativeFiniteNumber (minimum
-     *   0).
+     * @param a - The first non-negative finite number
+     * @param b - The second non-negative finite number
+     * @returns The difference of `a` and `b` as a `NonNegativeFiniteNumber`
      */
     readonly sub: (x: TtfImported_NonNegativeFiniteNumber, y: TtfImported_NonNegativeFiniteNumber) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * Multiplies two NonNegativeFiniteNumber values.
+     * Multiplies two non-negative finite numbers, returning `a * b` as a
+     * `NonNegativeFiniteNumber`.
      *
-     * @param a The first NonNegativeFiniteNumber.
-     * @param b The second NonNegativeFiniteNumber.
-     * @returns `a * b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+     * @param a - The first non-negative finite number
+     * @param b - The second non-negative finite number
+     * @returns The product of `a` and `b` as a `NonNegativeFiniteNumber`
      */
     readonly mul: (x: TtfImported_NonNegativeFiniteNumber, y: TtfImported_NonNegativeFiniteNumber) => TtfImported_NonNegativeFiniteNumber;
     /**
-     * Divides one NonNegativeFiniteNumber by another.
+     * Divides two non-negative finite numbers, returning `a / b` as a
+     * `NonNegativeFiniteNumber`.
      *
-     * @param a The dividend NonNegativeFiniteNumber.
-     * @param b The divisor NonNegativeFiniteNumber.
-     * @returns `a / b` clamped to [0, +∞) as a NonNegativeFiniteNumber.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns `a / b` as a `NonNegativeFiniteNumber`
      */
     readonly div: (x: TtfImported_NonNegativeFiniteNumber, y: number & {
         readonly "!=0": true;

package/dist/number/branded-types/non-negative-finite-number.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"non-negative-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,uBAAuB,IAAI,mCAAmC,EAEpE,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AAiD3C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;wBA/FA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAiG3D;;;;;OAKG;uBAjGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAmG3D;;;;;OAKG;wBAnGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAqG3D;;;;OAIG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"non-negative-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,uBAAuB,IAAI,mCAAmC,EAEpE,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAE1E,KAAK,WAAW,GAAG,uBAAuB,CAAC;AAiD3C;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,yDAAK,CAAC;AAE5C;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;MAAW,CAAC;AAElD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;wBAhGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAkG3D;;;;;;OAMG;uBAnGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAqG3D;;;;;;OAMG;wBAtGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAwG3D;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;CAEK,CAAC"}