ts-data-forge 11.0.0 → 12.0.0

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

@@ -1,19 +1,24 @@
 import { type NonPositiveSafeInt as TtfImported_NonPositiveSafeInt } from 'ts-type-forge';
 export type NonPositiveSafeInt = TtfImported_NonPositiveSafeInt;
 /**
- * Checks if a number is a NonPositiveSafeInt (non-positive safe integer in the
- * range [Number.MIN_SAFE_INTEGER, 0]).
+ * Type guard that checks if a value is a non-positive safe integer.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonPositiveSafeInt, `false` otherwise.
+ * Returns `true` for a non-positive safe integer — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-positive safe integer, `false` otherwise
  */
 export declare const isNonPositiveSafeInt: (a: number) => a is TtfImported_NonPositiveSafeInt;
 /**
- * Casts a number to a NonPositiveSafeInt type.
+ * Casts a `number` to the `NonPositiveSafeInt` branded type.
+ *
+ * Validates that the value is a non-positive safe integer and returns it with
+ * the `NonPositiveSafeInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonPositiveSafeInt type.
- * @throws {TypeError} If the value is not a non-positive safe integer.
+ * @param value - The value to cast
+ * @returns The value as a `NonPositiveSafeInt`
+ * @throws {TypeError} If the value is not a non-positive safe integer
  */
 export declare const asNonPositiveSafeInt: <N extends number>(x: N) => number & {
     readonly "< 2^15": true;
@@ -29,90 +34,93 @@ export declare const asNonPositiveSafeInt: <N extends number>(x: N) => number &
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for non-positive
- * safe integers.
+ * Namespace providing type-safe operations for the `NonPositiveSafeInt` branded
+ * type.
  *
- * All operations automatically clamp results to the valid NonPositiveSafeInt
- * range [Number.MIN_SAFE_INTEGER, 0]. This ensures that all arithmetic
- * maintains the non-positive safe integer constraint, with positive results
- * clamped to 0 and underflow results clamped to MIN_VALUE.
+ * The `NonPositiveSafeInt` type represents a non-positive safe integer.
+ * Division (`div`) uses floor division.
  */
 export declare const NonPositiveSafeInt: {
     /**
-     * Type guard to check if a value is a NonPositiveSafeInt.
+     * Type guard that checks if a value is a non-positive safe integer.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-positive safe integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-positive safe integer, `false` otherwise
+     * @see {@link isNonPositiveSafeInt} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonPositiveSafeInt;
     /**
-     * The minimum value for a non-positive safe integer.
-     *
-     * @readonly
+     * The smallest value representable as `NonPositiveSafeInt` (the lower
+     * saturation target of `fromNumber`).
      */
     readonly MIN_VALUE: number;
     /**
-     * The maximum value for a non-positive safe integer.
-     *
-     * @readonly
+     * The largest value representable as `NonPositiveSafeInt` (the upper
+     * saturation target of `fromNumber`).
      */
     readonly MAX_VALUE: 0;
     /**
-     * Returns the smaller of two NonPositiveSafeInt values.
+     * Returns the smallest of the given non-positive safe integers.
      *
-     * @param a The first NonPositiveSafeInt.
-     * @param b The second NonPositiveSafeInt.
-     * @returns The minimum value as a NonPositiveSafeInt.
+     * @param values - The non-positive safe integers to compare (at least one required)
+     * @returns The smallest value as a `NonPositiveSafeInt`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt>[]) => TtfImported_NonPositiveSafeInt;
     /**
-     * Returns the larger of two NonPositiveSafeInt values.
+     * Returns the largest of the given non-positive safe integers.
      *
-     * @param a The first NonPositiveSafeInt.
-     * @param b The second NonPositiveSafeInt.
-     * @returns The maximum value as a NonPositiveSafeInt.
+     * @param values - The non-positive safe integers to compare (at least one required)
+     * @returns The largest value as a `NonPositiveSafeInt`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt>[]) => TtfImported_NonPositiveSafeInt;
     /**
-     * Clamps a number to the NonPositiveSafeInt range.
+     * Converts an arbitrary `number` into a `NonPositiveSafeInt`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asNonPositiveSafeInt`, this is total: out-of-range inputs are
+     * clamped to the nearest representable `NonPositiveSafeInt` instead of
+     * throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-     *   NonPositiveSafeInt.
+     * @param value - The value to convert
+     * @returns The value as a `NonPositiveSafeInt`
      */
-    readonly clamp: (x: number) => TtfImported_NonPositiveSafeInt;
+    readonly fromNumber: (x: number) => TtfImported_NonPositiveSafeInt;
     /**
-     * Generates a random NonPositiveSafeInt value within the valid range.
+     * Generates a random `NonPositiveSafeInt` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random NonPositiveSafeInt between Number.MIN_SAFE_INTEGER and 0.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonPositiveSafeInt` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt> | undefined) => TtfImported_NonPositiveSafeInt;
     /**
-     * Raises a NonPositiveSafeInt to the power of another NonPositiveSafeInt.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveSafeInt`
+     * (floored to an integer).
      *
-     * @param a The base NonPositiveSafeInt.
-     * @param b The exponent NonPositiveSafeInt.
-     * @returns `a ** b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-     *   NonPositiveSafeInt.
+     * @param a - The base non-positive safe integer
+     * @param b - The exponent non-positive safe integer
+     * @returns `a ** b` as a `NonPositiveSafeInt`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt>) => TtfImported_NonPositiveSafeInt;
     /**
-     * Adds two NonPositiveSafeInt values.
+     * Adds two non-positive safe integers, returning `a + b` as a
+     * `NonPositiveSafeInt`.
      *
-     * @param a The first NonPositiveSafeInt.
-     * @param b The second NonPositiveSafeInt.
-     * @returns `a + b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-     *   NonPositiveSafeInt.
+     * @param a - The first non-positive safe integer
+     * @param b - The second non-positive safe integer
+     * @returns The sum of `a` and `b` as a `NonPositiveSafeInt`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt>) => TtfImported_NonPositiveSafeInt;
     /**
-     * Subtracts one NonPositiveSafeInt from another.
+     * Subtracts two non-positive safe integers, returning `a - b` as a
+     * `NonPositiveSafeInt`.
      *
-     * @param a The minuend NonPositiveSafeInt.
-     * @param b The subtrahend NonPositiveSafeInt.
-     * @returns `a - b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-     *   NonPositiveSafeInt (maximum 0).
+     * @param a - The first non-positive safe integer
+     * @param b - The second non-positive safe integer
+     * @returns The difference of `a` and `b` as a `NonPositiveSafeInt`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonPositiveSafeInt>) => TtfImported_NonPositiveSafeInt;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-positive-safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,kBAAkB,IAAI,8BAA8B,EAAE,MAAM,eAAe,CAAC;AAG1F,MAAM,MAAM,kBAAkB,GAAG,8BAA8B,CAAC;AA6BhE;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,oDAAK,CAAC;AAEvC;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;MAAW,CAAC;AAE7C;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB;IAC7B;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}
+{"version":3,"file":"non-positive-safe-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-positive-safe-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,kBAAkB,IAAI,8BAA8B,EAAE,MAAM,eAAe,CAAC;AAG1F,MAAM,MAAM,kBAAkB,GAAG,8BAA8B,CAAC;AA6BhE;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,oDAAK,CAAC;AAEvC;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;MAAW,CAAC;AAE7C;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;IAC7B;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;;OAWG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;CAEK,CAAC"}

package/dist/number/branded-types/non-positive-safe-int.mjs

@@ -6,7 +6,7 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -23,80 +23,85 @@ const isNonPositiveSafeInt = is;
 const asNonPositiveSafeInt = castType;
 const NonPositiveSafeInt = {
   /**
-   * Type guard to check if a value is a NonPositiveSafeInt.
+   * Type guard that checks if a value is a non-positive safe integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-positive safe integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-positive safe integer, `false` otherwise
+   * @see {@link isNonPositiveSafeInt} for usage examples
    */
   is,
   /**
-   * The minimum value for a non-positive safe integer.
-   *
-   * @readonly
+   * The smallest value representable as `NonPositiveSafeInt` (the lower
+   * saturation target of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum value for a non-positive safe integer.
-   *
-   * @readonly
+   * The largest value representable as `NonPositiveSafeInt` (the upper
+   * saturation target of `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two NonPositiveSafeInt values.
+   * Returns the smallest of the given non-positive safe integers.
    *
-   * @param a The first NonPositiveSafeInt.
-   * @param b The second NonPositiveSafeInt.
-   * @returns The minimum value as a NonPositiveSafeInt.
+   * @param values - The non-positive safe integers to compare (at least one required)
+   * @returns The smallest value as a `NonPositiveSafeInt`
    */
   min: min_,
   /**
-   * Returns the larger of two NonPositiveSafeInt values.
+   * Returns the largest of the given non-positive safe integers.
    *
-   * @param a The first NonPositiveSafeInt.
-   * @param b The second NonPositiveSafeInt.
-   * @returns The maximum value as a NonPositiveSafeInt.
+   * @param values - The non-positive safe integers to compare (at least one required)
+   * @returns The largest value as a `NonPositiveSafeInt`
    */
   max: max_,
   /**
-   * Clamps a number to the NonPositiveSafeInt range.
+   * Converts an arbitrary `number` into a `NonPositiveSafeInt`, rounding to the
+   * nearest integer and saturating the result into the range `[MIN_VALUE,
+   * MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-   *   NonPositiveSafeInt.
+   * Unlike `asNonPositiveSafeInt`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `NonPositiveSafeInt` instead of
+   * throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NonPositiveSafeInt`
    */
-  clamp,
+  fromNumber,
   /**
-   * Generates a random NonPositiveSafeInt value within the valid range.
+   * Generates a random `NonPositiveSafeInt` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random NonPositiveSafeInt between Number.MIN_SAFE_INTEGER and 0.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonPositiveSafeInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a NonPositiveSafeInt to the power of another NonPositiveSafeInt.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveSafeInt`
+   * (floored to an integer).
    *
-   * @param a The base NonPositiveSafeInt.
-   * @param b The exponent NonPositiveSafeInt.
-   * @returns `a ** b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-   *   NonPositiveSafeInt.
+   * @param a - The base non-positive safe integer
+   * @param b - The exponent non-positive safe integer
+   * @returns `a ** b` as a `NonPositiveSafeInt`
    */
   pow,
   /**
-   * Adds two NonPositiveSafeInt values.
+   * Adds two non-positive safe integers, returning `a + b` as a
+   * `NonPositiveSafeInt`.
    *
-   * @param a The first NonPositiveSafeInt.
-   * @param b The second NonPositiveSafeInt.
-   * @returns `a + b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-   *   NonPositiveSafeInt.
+   * @param a - The first non-positive safe integer
+   * @param b - The second non-positive safe integer
+   * @returns The sum of `a` and `b` as a `NonPositiveSafeInt`
    */
   add,
   /**
-   * Subtracts one NonPositiveSafeInt from another.
+   * Subtracts two non-positive safe integers, returning `a - b` as a
+   * `NonPositiveSafeInt`.
    *
-   * @param a The minuend NonPositiveSafeInt.
-   * @param b The subtrahend NonPositiveSafeInt.
-   * @returns `a - b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a
-   *   NonPositiveSafeInt (maximum 0).
+   * @param a - The first non-positive safe integer
+   * @param b - The second non-positive safe integer
+   * @returns The difference of `a` and `b` as a `NonPositiveSafeInt`
    */
   sub
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-positive-safe-int.mjs","sources":["../../../src/number/branded-types/non-positive-safe-int.mts"],"sourcesContent":["import { type NonPositiveSafeInt as TtfImported_NonPositiveSafeInt } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonPositiveSafeInt = TtfImported_NonPositiveSafeInt;\n\ntype ElementType = NonPositiveSafeInt;\n\nconst typeNameInMessage = 'a non-positive 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  0\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: 0,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a NonPositiveSafeInt (non-positive safe integer in the\n * range [Number.MIN_SAFE_INTEGER, 0]).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonPositiveSafeInt, `false` otherwise.\n */\nexport const isNonPositiveSafeInt = is;\n\n/**\n * Casts a number to a NonPositiveSafeInt type.\n *\n * @param value The value to cast.\n * @returns The value as a NonPositiveSafeInt type.\n * @throws {TypeError} If the value is not a non-positive safe integer.\n */\nexport const asNonPositiveSafeInt = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for non-positive\n * safe integers.\n *\n * All operations automatically clamp results to the valid NonPositiveSafeInt\n * range [Number.MIN_SAFE_INTEGER, 0]. This ensures that all arithmetic\n * maintains the non-positive safe integer constraint, with positive results\n * clamped to 0 and underflow results clamped to MIN_VALUE.\n */\nexport const NonPositiveSafeInt = {\n  /**\n   * Type guard to check if a value is a NonPositiveSafeInt.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-positive safe integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a non-positive safe integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum value for a non-positive safe integer.\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two NonPositiveSafeInt values.\n   *\n   * @param a The first NonPositiveSafeInt.\n   * @param b The second NonPositiveSafeInt.\n   * @returns The minimum value as a NonPositiveSafeInt.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonPositiveSafeInt values.\n   *\n   * @param a The first NonPositiveSafeInt.\n   * @param b The second NonPositiveSafeInt.\n   * @returns The maximum value as a NonPositiveSafeInt.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the NonPositiveSafeInt range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [Number.MIN_SAFE_INTEGER, 0] as a\n   *   NonPositiveSafeInt.\n   */\n  clamp,\n\n  /**\n   * Generates a random NonPositiveSafeInt value within the valid range.\n   *\n   * @returns A random NonPositiveSafeInt between Number.MIN_SAFE_INTEGER and 0.\n   */\n  random,\n\n  /**\n   * Raises a NonPositiveSafeInt to the power of another NonPositiveSafeInt.\n   *\n   * @param a The base NonPositiveSafeInt.\n   * @param b The exponent NonPositiveSafeInt.\n   * @returns `a ** b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a\n   *   NonPositiveSafeInt.\n   */\n  pow,\n\n  /**\n   * Adds two NonPositiveSafeInt values.\n   *\n   * @param a The first NonPositiveSafeInt.\n   * @param b The second NonPositiveSafeInt.\n   * @returns `a + b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a\n   *   NonPositiveSafeInt.\n   */\n  add,\n\n  /**\n   * Subtracts one NonPositiveSafeInt from another.\n   *\n   * @param a The minuend NonPositiveSafeInt.\n   * @param b The subtrahend NonPositiveSafeInt.\n   * @returns `a - b` clamped to [Number.MIN_SAFE_INTEGER, 0] as a\n   *   NonPositiveSafeInt (maximum 0).\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;AAOA,MAAM,iBAAA,GAAoB,6BAAA;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,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,CAAA;AAAA,EACX;AACF,CAAU,CAAA;AASH,MAAM,oBAAA,GAAuB;AAS7B,MAAM,oBAAA,GAAuB;AAW7B,MAAM,kBAAA,GAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQhC,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;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;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}
+{"version":3,"file":"non-positive-safe-int.mjs","sources":["../../../src/number/branded-types/non-positive-safe-int.mts"],"sourcesContent":["import { type NonPositiveSafeInt as TtfImported_NonPositiveSafeInt } from 'ts-type-forge';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonPositiveSafeInt = TtfImported_NonPositiveSafeInt;\n\ntype ElementType = NonPositiveSafeInt;\n\nconst typeNameInMessage = 'a non-positive safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  0\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: Number.MIN_SAFE_INTEGER,\n  MAX_VALUE: 0,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-positive safe integer.\n *\n * Returns `true` for a non-positive 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-positive safe integer, `false` otherwise\n */\nexport const isNonPositiveSafeInt = is;\n\n/**\n * Casts a `number` to the `NonPositiveSafeInt` branded type.\n *\n * Validates that the value is a non-positive safe integer and returns it with\n * the `NonPositiveSafeInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonPositiveSafeInt`\n * @throws {TypeError} If the value is not a non-positive safe integer\n */\nexport const asNonPositiveSafeInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonPositiveSafeInt` branded\n * type.\n *\n * The `NonPositiveSafeInt` type represents a non-positive safe integer.\n * Division (`div`) uses floor division.\n */\nexport const NonPositiveSafeInt = {\n  /**\n   * Type guard that checks if a value is a non-positive safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-positive safe integer, `false` otherwise\n   * @see {@link isNonPositiveSafeInt} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonPositiveSafeInt` (the lower\n   * saturation target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `NonPositiveSafeInt` (the upper\n   * saturation target of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-positive safe integers.\n   *\n   * @param values - The non-positive safe integers to compare (at least one required)\n   * @returns The smallest value as a `NonPositiveSafeInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-positive safe integers.\n   *\n   * @param values - The non-positive safe integers to compare (at least one required)\n   * @returns The largest value as a `NonPositiveSafeInt`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonPositiveSafeInt`, rounding to the\n   * nearest integer and saturating the result into the range `[MIN_VALUE,\n   * MAX_VALUE]`.\n   *\n   * Unlike `asNonPositiveSafeInt`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `NonPositiveSafeInt` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonPositiveSafeInt`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `NonPositiveSafeInt` 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 `NonPositiveSafeInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonPositiveSafeInt`\n   * (floored to an integer).\n   *\n   * @param a - The base non-positive safe integer\n   * @param b - The exponent non-positive safe integer\n   * @returns `a ** b` as a `NonPositiveSafeInt`\n   */\n  pow,\n\n  /**\n   * Adds two non-positive safe integers, returning `a + b` as a\n   * `NonPositiveSafeInt`.\n   *\n   * @param a - The first non-positive safe integer\n   * @param b - The second non-positive safe integer\n   * @returns The sum of `a` and `b` as a `NonPositiveSafeInt`\n   */\n  add,\n\n  /**\n   * Subtracts two non-positive safe integers, returning `a - b` as a\n   * `NonPositiveSafeInt`.\n   *\n   * @param a - The first non-positive safe integer\n   * @param b - The second non-positive safe integer\n   * @returns The difference of `a` and `b` as a `NonPositiveSafeInt`\n   */\n  sub,\n} as const;\n"],"names":[],"mappings":";;AAOA,MAAM,iBAAA,GAAoB,6BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,UAAA;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,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB,SAAA,EAAW,CAAA;AAAA,EACX;AACF,CAAU,CAAA;AAWH,MAAM,oBAAA,GAAuB;AAY7B,MAAM,oBAAA,GAAuB;AAS7B,MAAM,kBAAA,GAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQhC,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;AAAA;AAAA,EAcL,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;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}

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

@@ -3,18 +3,24 @@ import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 export type NonZeroFiniteNumber = TtfImported_NonZeroFiniteNumber;
 type ElementType = NonZeroFiniteNumber;
 /**
- * Checks if a number is a NonZeroFiniteNumber (a finite number that is not 0).
+ * Type guard that checks if a value is a non-zero finite number.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroFiniteNumber, `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-zero finite number, `false` otherwise
  */
 export declare const isNonZeroFiniteNumber: (a: number) => a is TtfImported_NonZeroFiniteNumber;
 /**
- * Casts a number to a NonZeroFiniteNumber type.
+ * Casts a `number` to the `NonZeroFiniteNumber` branded type.
+ *
+ * Validates that the value is a non-zero finite number and returns it with the
+ * `NonZeroFiniteNumber` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonZeroFiniteNumber type.
- * @throws {TypeError} If the value is not a non-zero finite number.
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroFiniteNumber`
+ * @throws {TypeError} If the value is not a non-zero finite number
  */
 export declare const asNonZeroFiniteNumber: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -24,98 +30,105 @@ export declare const asNonZeroFiniteNumber: <N extends number>(x: N) => number &
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for non-zero finite
- * numbers.
+ * Namespace providing type-safe operations for the `NonZeroFiniteNumber`
+ * branded type.
  *
- * All operations maintain the non-zero constraint while ensuring results remain
- * finite (excluding NaN and Infinity). This type is useful for values that must
- * never be zero, such as denominators, scaling factors, and ratios.
+ * The `NonZeroFiniteNumber` type represents a non-zero finite number.
  */
 export declare const NonZeroFiniteNumber: {
     /**
-     * Type guard to check if a value is a NonZeroFiniteNumber.
+     * Type guard that checks if a value is a non-zero finite number.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-zero finite number, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-zero finite number, `false` otherwise
+     * @see {@link isNonZeroFiniteNumber} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonZeroFiniteNumber;
     /**
      * Returns the absolute value of a non-zero finite number.
      *
-     * @param a The NonZeroFiniteNumber.
-     * @returns The absolute value as a NonZeroFiniteNumber.
+     * The result is non-negative and keeps the `NonZeroFiniteNumber` brand.
+     *
+     * @param a - The non-zero finite number value
+     * @returns The absolute value as a non-negative `NonZeroFiniteNumber`
      */
     readonly abs: (x: TtfImported_NonZeroFiniteNumber) => import("ts-type-forge").IntersectBrand<TtfImported_NonZeroFiniteNumber, import("ts-type-forge").PositiveNumber>;
     /**
-     * Returns the smaller of two NonZeroFiniteNumber values.
+     * Returns the smallest of the given non-zero finite numbers.
      *
-     * @param a The first NonZeroFiniteNumber.
-     * @param b The second NonZeroFiniteNumber.
-     * @returns The minimum value as a NonZeroFiniteNumber.
+     * @param values - The non-zero finite numbers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroFiniteNumber`
      */
     readonly min: (...values: readonly TtfImported_NonZeroFiniteNumber[]) => TtfImported_NonZeroFiniteNumber;
     /**
-     * Returns the larger of two NonZeroFiniteNumber values.
+     * Returns the largest of the given non-zero finite numbers.
      *
-     * @param a The first NonZeroFiniteNumber.
-     * @param b The second NonZeroFiniteNumber.
-     * @returns The maximum value as a NonZeroFiniteNumber.
+     * @param values - The non-zero finite numbers to compare (at least one required)
+     * @returns The largest value as a `NonZeroFiniteNumber`
      */
     readonly max: (...values: readonly TtfImported_NonZeroFiniteNumber[]) => TtfImported_NonZeroFiniteNumber;
     /**
-     * Rounds down a NonZeroFiniteNumber to the nearest integer.
+     * Returns the greatest integer less than or equal to a non-zero finite
+     * number.
      *
-     * @param x The NonZeroFiniteNumber to round down.
-     * @returns The floor value as a NonZeroInt.
+     * @param a - The non-zero finite number value
+     * @returns The floored value as an integer
      */
     readonly floor: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Rounds up a NonZeroFiniteNumber to the nearest integer.
+     * Returns the smallest integer greater than or equal to a non-zero finite
+     * number.
      *
-     * @param x The NonZeroFiniteNumber to round up.
-     * @returns The ceiling value as a NonZeroInt.
+     * @param a - The non-zero finite number value
+     * @returns The ceiled value as an integer
      */
     readonly ceil: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Rounds a NonZeroFiniteNumber to the nearest integer.
+     * Returns the value of a non-zero finite number rounded to the nearest
+     * integer.
      *
-     * @param x The NonZeroFiniteNumber to round.
-     * @returns The rounded value as a NonZeroInt.
+     * @param a - The non-zero finite number value
+     * @returns The rounded value as an integer
      */
     readonly round: (x: ElementType) => TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;
     /**
-     * Generates a random NonZeroFiniteNumber value.
+     * Generates a random `NonZeroFiniteNumber` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random non-zero finite number.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonZeroFiniteNumber` in `[min, max]`
      */
     readonly random: (min?: TtfImported_NonZeroFiniteNumber | undefined, max?: TtfImported_NonZeroFiniteNumber | undefined) => TtfImported_NonZeroFiniteNumber;
     /**
-     * Raises a NonZeroFiniteNumber to the power of another NonZeroFiniteNumber.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroFiniteNumber`.
      *
-     * @param a The base NonZeroFiniteNumber.
-     * @param b The exponent NonZeroFiniteNumber.
-     * @returns `a ** b` as a NonZeroFiniteNumber.
+     * @param a - The base non-zero finite number
+     * @param b - The exponent non-zero finite number
+     * @returns `a ** b` as a `NonZeroFiniteNumber`
      */
     readonly pow: (x: TtfImported_NonZeroFiniteNumber, y: TtfImported_NonZeroFiniteNumber) => TtfImported_NonZeroFiniteNumber;
     /**
-     * Multiplies two NonZeroFiniteNumber values.
+     * Multiplies two non-zero finite numbers, returning `a * b` as a
+     * `NonZeroFiniteNumber`.
      *
-     * @param a The first NonZeroFiniteNumber.
-     * @param b The second NonZeroFiniteNumber.
-     * @returns `a * b` as a NonZeroFiniteNumber.
+     * @param a - The first non-zero finite number
+     * @param b - The second non-zero finite number
+     * @returns The product of `a` and `b` as a `NonZeroFiniteNumber`
      */
     readonly mul: (x: TtfImported_NonZeroFiniteNumber, y: TtfImported_NonZeroFiniteNumber) => TtfImported_NonZeroFiniteNumber;
     /**
-     * Divides one NonZeroFiniteNumber by another.
+     * Divides two non-zero finite numbers, returning `a / b` as a
+     * `NonZeroFiniteNumber`.
      *
      * Exact (non-flooring) division of two non-zero finite numbers is always
      * non-zero, so this stays closed. For the non-closed operations (`add`/`sub`,
      * whose result may be `0`) use {@link Num.add}/{@link Num.sub}.
      *
-     * @param a The dividend NonZeroFiniteNumber.
-     * @param b The divisor NonZeroFiniteNumber.
-     * @returns `a / b` as a NonZeroFiniteNumber.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns `a / b` as a `NonZeroFiniteNumber`
      */
     readonly div: (x: TtfImported_NonZeroFiniteNumber, y: number & {
         readonly "!=0": true;

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,mBAAmB,IAAI,+BAA+B,EAC5D,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,mBAAmB,GAAG,+BAA+B,CAAC;AAElE,KAAK,WAAW,GAAG,mBAAmB,CAAC;AAyDvC;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,qDAAK,CAAC;AAExC;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;;;;;MAAW,CAAC;AAE9C;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB;IAC9B;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;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;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;;OAUG;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"non-zero-finite-number.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-finite-number.mts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,mBAAmB,IAAI,+BAA+B,EAC5D,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,mBAAmB,GAAG,+BAA+B,CAAC;AAElE,KAAK,WAAW,GAAG,mBAAmB,CAAC;AAuDvC;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,qDAAK,CAAC;AAExC;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB;;;;;;MAAW,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;IAC9B;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;wBApGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAsG3D;;;;;;OAMG;uBAvGA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IAyG3D;;;;;;OAMG;wBA1GA,WAAW,KACb,oBAAoB,CAAC,kBAAkB,CAAC,KAAK,CAAC,WAAW,CAAC;IA4G3D;;;;;;;;OAQG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;;;;OAWG;;;;;;;;CAEK,CAAC"}