ts-data-forge 11.0.0 → 12.0.0

package/dist/number/branded-types/non-zero-finite-number.mjs

@@ -33,89 +33,98 @@ const isNonZeroFiniteNumber = is;
 const asNonZeroFiniteNumber = castType;
 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
    */
   is,
   /**
    * 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`
    */
   abs,
   /**
-   * 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`
    */
   min: min_,
   /**
-   * 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`
    */
   max: max_,
   /**
-   * 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
    */
   floor,
   /**
-   * 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
    */
   ceil,
   /**
-   * 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
    */
   round,
   /**
-   * 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]`
    */
   random,
   /**
-   * 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`
    */
   pow,
   /**
-   * 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`
    */
   mul,
   /**
-   * 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`
    */
   div
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-finite-number.mjs","sources":["../../../src/number/branded-types/non-zero-finite-number.mts"],"sourcesContent":["import {\n  type Int,\n  type NonZeroInt,\n  type PositiveFiniteNumber,\n  type NonZeroFiniteNumber as TtfImported_NonZeroFiniteNumber,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroFiniteNumber = TtfImported_NonZeroFiniteNumber;\n\ntype ElementType = NonZeroFiniteNumber;\n\nconst typeNameInMessage = 'a non-zero finite number';\n\nconst {\n  abs,\n  castType,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\n// Not provided because reasonable rounding operations that avoid becoming 0 cannot be defined\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.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  NonZeroInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Int\n>('=');\n\n/**\n * Checks if a number is a NonZeroFiniteNumber (a finite number that is not 0).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonZeroFiniteNumber, `false` otherwise.\n */\nexport const isNonZeroFiniteNumber = is;\n\n/**\n * Casts a number to a NonZeroFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a NonZeroFiniteNumber type.\n * @throws {TypeError} If the value is not a non-zero finite number.\n */\nexport const asNonZeroFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for non-zero finite\n * numbers.\n *\n * All operations maintain the non-zero constraint while ensuring results remain\n * finite (excluding NaN and Infinity). This type is useful for values that must\n * never be zero, such as denominators, scaling factors, and ratios.\n */\nexport const NonZeroFiniteNumber = {\n  /**\n   * Type guard to check if a value is a NonZeroFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-zero finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * Returns the absolute value of a non-zero finite number.\n   *\n   * @param a The NonZeroFiniteNumber.\n   * @returns The absolute value as a NonZeroFiniteNumber.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two NonZeroFiniteNumber values.\n   *\n   * @param a The first NonZeroFiniteNumber.\n   * @param b The second NonZeroFiniteNumber.\n   * @returns The minimum value as a NonZeroFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonZeroFiniteNumber values.\n   *\n   * @param a The first NonZeroFiniteNumber.\n   * @param b The second NonZeroFiniteNumber.\n   * @returns The maximum value as a NonZeroFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Rounds down a NonZeroFiniteNumber to the nearest integer.\n   *\n   * @param x The NonZeroFiniteNumber to round down.\n   * @returns The floor value as a NonZeroInt.\n   */\n  floor,\n\n  /**\n   * Rounds up a NonZeroFiniteNumber to the nearest integer.\n   *\n   * @param x The NonZeroFiniteNumber to round up.\n   * @returns The ceiling value as a NonZeroInt.\n   */\n  ceil,\n\n  /**\n   * Rounds a NonZeroFiniteNumber to the nearest integer.\n   *\n   * @param x The NonZeroFiniteNumber to round.\n   * @returns The rounded value as a NonZeroInt.\n   */\n  round,\n\n  /**\n   * Generates a random NonZeroFiniteNumber value.\n   *\n   * @returns A random non-zero finite number.\n   */\n  random,\n\n  /**\n   * Raises a NonZeroFiniteNumber to the power of another NonZeroFiniteNumber.\n   *\n   * @param a The base NonZeroFiniteNumber.\n   * @param b The exponent NonZeroFiniteNumber.\n   * @returns `a ** b` as a NonZeroFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Multiplies two NonZeroFiniteNumber values.\n   *\n   * @param a The first NonZeroFiniteNumber.\n   * @param b The second NonZeroFiniteNumber.\n   * @returns `a * b` as a NonZeroFiniteNumber.\n   */\n  mul,\n\n  /**\n   * Divides one NonZeroFiniteNumber by another.\n   *\n   * Exact (non-flooring) division of two non-zero finite numbers is always\n   * non-zero, so this stays closed. For the non-closed operations (`add`/`sub`,\n   * whose result may be `0`) use {@link Num.add}/{@link Num.sub}.\n   *\n   * @param a The dividend NonZeroFiniteNumber.\n   * @param b The divisor NonZeroFiniteNumber.\n   * @returns `a / b` as a NonZeroFiniteNumber.\n   */\n  div,\n} as const;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToNonNegative<ElementType>,\n  PositiveFiniteNumber\n>('=');\n\nexpectType<\n  keyof typeof NonZeroFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    never,\n    'div' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    never,\n    'div' | 'mul'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAaA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAIV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAoBP,MAAM,qBAAA,GAAwB;AAS9B,MAAM,qBAAA,GAAwB;AAU9B,MAAM,mBAAA,GAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjC,EAAA;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,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;AAAA,EAaA;AACF;;;;"}
+{"version":3,"file":"non-zero-finite-number.mjs","sources":["../../../src/number/branded-types/non-zero-finite-number.mts"],"sourcesContent":["import {\n  type Int,\n  type NonZeroInt,\n  type PositiveFiniteNumber,\n  type NonZeroFiniteNumber as TtfImported_NonZeroFiniteNumber,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroFiniteNumber = TtfImported_NonZeroFiniteNumber;\n\ntype ElementType = NonZeroFiniteNumber;\n\nconst typeNameInMessage = 'a non-zero finite number';\n\nconst {\n  abs,\n  castType,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  number,\n  number\n>({\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\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.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.ceil(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nconst round = (\n  x: ElementType,\n): TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType> =>\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion\n  Math.round(x) as TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>,\n  NonZeroInt\n>('=');\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.RemoveNonZeroBrandKey<\n    TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>\n  >,\n  Int\n>('=');\n\n/**\n * Type guard that checks if a value is a non-zero finite number.\n *\n * Returns `true` only for a finite value — never `NaN`, `Infinity`, or\n * `-Infinity`.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-zero finite number, `false` otherwise\n */\nexport const isNonZeroFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonZeroFiniteNumber` branded type.\n *\n * Validates that the value is a non-zero finite number and returns it with the\n * `NonZeroFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroFiniteNumber`\n * @throws {TypeError} If the value is not a non-zero finite number\n */\nexport const asNonZeroFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroFiniteNumber`\n * branded type.\n *\n * The `NonZeroFiniteNumber` type represents a non-zero finite number.\n */\nexport const NonZeroFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-zero finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero finite number, `false` otherwise\n   * @see {@link isNonZeroFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * Returns the absolute value of a non-zero finite number.\n   *\n   * The result is non-negative and keeps the `NonZeroFiniteNumber` brand.\n   *\n   * @param a - The non-zero finite number value\n   * @returns The absolute value as a non-negative `NonZeroFiniteNumber`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given non-zero finite numbers.\n   *\n   * @param values - The non-zero finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero finite numbers.\n   *\n   * @param values - The non-zero finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonZeroFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-zero finite\n   * number.\n   *\n   * @param a - The non-zero finite number value\n   * @returns The floored value as an integer\n   */\n  floor,\n\n  /**\n   * Returns the smallest integer greater than or equal to a non-zero finite\n   * number.\n   *\n   * @param a - The non-zero finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-zero finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-zero finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonZeroFiniteNumber` 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 `NonZeroFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroFiniteNumber`.\n   *\n   * @param a - The base non-zero finite number\n   * @param b - The exponent non-zero finite number\n   * @returns `a ** b` as a `NonZeroFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Multiplies two non-zero finite numbers, returning `a * b` as a\n   * `NonZeroFiniteNumber`.\n   *\n   * @param a - The first non-zero finite number\n   * @param b - The second non-zero finite number\n   * @returns The product of `a` and `b` as a `NonZeroFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two non-zero finite numbers, returning `a / b` as a\n   * `NonZeroFiniteNumber`.\n   *\n   * Exact (non-flooring) division of two non-zero finite numbers is always\n   * non-zero, so this stays closed. For the non-closed operations (`add`/`sub`,\n   * whose result may be `0`) use {@link Num.add}/{@link Num.sub}.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `NonZeroFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  TsDataForgeInternals.RefinedNumberUtils.ToNonNegative<ElementType>,\n  PositiveFiniteNumber\n>('=');\n\nexpectType<\n  keyof typeof NonZeroFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    never,\n    'div' | 'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    never,\n    'div' | 'mul'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAaA,MAAM,iBAAA,GAAoB,0BAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,OAAA,EAAS,IAAA;AAAA,EACT,SAAA,EAAW,CAAC,MAAA,CAAO,SAAA;AAAA,EACnB,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAEV,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAEd,MAAM,OAAO,CACX,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,KAAK,CAAC;AAAA,CAAA;AAEb,MAAM,QAAQ,CACZ,CAAA;AAAA;AAAA,EAGA,IAAA,CAAK,MAAM,CAAC;AAAA,CAAA;AAuBP,MAAM,qBAAA,GAAwB;AAY9B,MAAM,qBAAA,GAAwB;AAQ9B,MAAM,mBAAA,GAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjC,EAAA;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,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA;AACF;;;;"}

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

@@ -1,18 +1,24 @@
 import { type NonZeroInt as TtfImported_NonZeroInt } from 'ts-type-forge';
 export type NonZeroInt = TtfImported_NonZeroInt;
 /**
- * Checks if a number is a NonZeroInt.
+ * Type guard that checks if a value is a non-zero integer.
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroInt, `false` otherwise.
+ * Returns `true` for a non-zero integer — a value with no fractional component,
+ * including values outside the safe integer range (unlike `SafeInt`).
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero integer, `false` otherwise
  */
 export declare const isNonZeroInt: (a: number) => a is TtfImported_NonZeroInt;
 /**
- * Casts a number to a NonZeroInt type.
+ * Casts a `number` to the `NonZeroInt` branded type.
+ *
+ * Validates that the value is a non-zero integer and returns it with the
+ * `NonZeroInt` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonZeroInt type.
- * @throws {TypeError} If the value is not a non-zero integer.
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroInt`
+ * @throws {TypeError} If the value is not a non-zero integer
  */
 export declare const asNonZeroInt: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -23,67 +29,74 @@ export declare const asNonZeroInt: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for non-zero integers.
+ * Namespace providing type-safe operations for the `NonZeroInt` branded type.
+ *
+ * The `NonZeroInt` type represents a non-zero integer. Division (`div`) uses
+ * floor division.
  *
- * All operations maintain the non-zero constraint, ensuring that results are
- * always valid NonZeroInt values. Division operations return floor division
- * results, and all arithmetic maintains integer precision.
+ * Unlike `SafeInt`, `NonZeroInt` allows values outside the safe integer range
+ * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's
+ * `number` type.
  */
 export declare const NonZeroInt: {
     /**
-     * Type guard to check if a value is a NonZeroInt.
+     * Type guard that checks if a value is a non-zero integer.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-zero integer, `false` otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-zero integer, `false` otherwise
+     * @see {@link isNonZeroInt} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonZeroInt;
     /**
      * Returns the absolute value of a non-zero integer.
      *
-     * @param a The non-zero integer.
-     * @returns The absolute value as a NonZeroInt.
+     * The result is non-negative and keeps the `NonZeroInt` brand. Note that
+     * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
+     * use `SafeInt` for guaranteed precision.
+     *
+     * @param a - The non-zero integer value
+     * @returns The absolute value as a non-negative `NonZeroInt`
      */
     readonly abs: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt>) => import("ts-type-forge").IntersectBrand<TtfImported_NonZeroInt, import("ts-type-forge").PositiveNumber>;
     /**
-     * Returns the smaller of two non-zero integers.
+     * Returns the smallest of the given non-zero integers.
      *
-     * @param a The first non-zero integer.
-     * @param b The second non-zero integer.
-     * @returns The minimum value as a NonZeroInt.
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroInt`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt>[]) => TtfImported_NonZeroInt;
     /**
-     * Returns the larger of two non-zero integers.
+     * Returns the largest of the given non-zero integers.
      *
-     * @param a The first non-zero integer.
-     * @param b The second non-zero integer.
-     * @returns The maximum value as a NonZeroInt.
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The largest value as a `NonZeroInt`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt>[]) => TtfImported_NonZeroInt;
     /**
-     * Generates a random non-zero integer.
+     * Generates a random `NonZeroInt` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random NonZeroInt value.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonZeroInt` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt> | undefined) => TtfImported_NonZeroInt;
     /**
-     * Raises a non-zero integer to the power of another non-zero integer.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroInt` (floored
+     * to an integer).
      *
-     * @param a The base non-zero integer.
-     * @param b The exponent non-zero integer.
-     * @returns `a ** b` as a NonZeroInt.
+     * @param a - The base non-zero integer
+     * @param b - The exponent non-zero integer
+     * @returns `a ** b` as a `NonZeroInt`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt>) => TtfImported_NonZeroInt;
     /**
-     * Multiplies two non-zero integers.
-     *
-     * The product of two non-zero integers is always non-zero, so this stays
-     * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
-     * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+     * Multiplies two non-zero integers, returning `a * b` as a `NonZeroInt`.
      *
-     * @param a The first non-zero integer.
-     * @param b The second non-zero integer.
-     * @returns `a * b` as a NonZeroInt.
+     * @param a - The first non-zero integer
+     * @param b - The second non-zero integer
+     * @returns The product of `a` and `b` as a `NonZeroInt`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt>) => TtfImported_NonZeroInt;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,IAAI,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAI1E,MAAM,MAAM,UAAU,GAAG,sBAAsB,CAAC;AA2BhD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,4CAAK,CAAC;AAE/B;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;;;;;;MAAW,CAAC;AAErC;;;;;;GAMG;AACH,eAAO,MAAM,UAAU;IACrB;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;;OAUG;;CAEK,CAAC"}
+{"version":3,"file":"non-zero-int.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-int.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,IAAI,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAI1E,MAAM,MAAM,UAAU,GAAG,sBAAsB,CAAC;AA2BhD;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,4CAAK,CAAC;AAE/B;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY;;;;;;;MAAW,CAAC;AAErC;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU;IACrB;;;;;;OAMG;;IAGH;;;;;;;;;OASG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}

package/dist/number/branded-types/non-zero-int.mjs

@@ -21,59 +21,63 @@ const isNonZeroInt = is;
 const asNonZeroInt = castType;
 const NonZeroInt = {
   /**
-   * Type guard to check if a value is a NonZeroInt.
+   * Type guard that checks if a value is a non-zero integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-zero integer, `false` otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-zero integer, `false` otherwise
+   * @see {@link isNonZeroInt} for usage examples
    */
   is,
   /**
    * Returns the absolute value of a non-zero integer.
    *
-   * @param a The non-zero integer.
-   * @returns The absolute value as a NonZeroInt.
+   * The result is non-negative and keeps the `NonZeroInt` brand. Note that
+   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so
+   * use `SafeInt` for guaranteed precision.
+   *
+   * @param a - The non-zero integer value
+   * @returns The absolute value as a non-negative `NonZeroInt`
    */
   abs,
   /**
-   * Returns the smaller of two non-zero integers.
+   * Returns the smallest of the given non-zero integers.
    *
-   * @param a The first non-zero integer.
-   * @param b The second non-zero integer.
-   * @returns The minimum value as a NonZeroInt.
+   * @param values - The non-zero integers to compare (at least one required)
+   * @returns The smallest value as a `NonZeroInt`
    */
   min: min_,
   /**
-   * Returns the larger of two non-zero integers.
+   * Returns the largest of the given non-zero integers.
    *
-   * @param a The first non-zero integer.
-   * @param b The second non-zero integer.
-   * @returns The maximum value as a NonZeroInt.
+   * @param values - The non-zero integers to compare (at least one required)
+   * @returns The largest value as a `NonZeroInt`
    */
   max: max_,
   /**
-   * Generates a random non-zero integer.
+   * Generates a random `NonZeroInt` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random NonZeroInt value.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonZeroInt` in `[min, max]`
    */
   random,
   /**
-   * Raises a non-zero integer to the power of another non-zero integer.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroInt` (floored
+   * to an integer).
    *
-   * @param a The base non-zero integer.
-   * @param b The exponent non-zero integer.
-   * @returns `a ** b` as a NonZeroInt.
+   * @param a - The base non-zero integer
+   * @param b - The exponent non-zero integer
+   * @returns `a ** b` as a `NonZeroInt`
    */
   pow,
   /**
-   * Multiplies two non-zero integers.
-   *
-   * The product of two non-zero integers is always non-zero, so this stays
-   * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
-   * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroInt`.
    *
-   * @param a The first non-zero integer.
-   * @param b The second non-zero integer.
-   * @returns `a * b` as a NonZeroInt.
+   * @param a - The first non-zero integer
+   * @param b - The second non-zero integer
+   * @returns The product of `a` and `b` as a `NonZeroInt`
    */
   mul
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-int.mjs","sources":["../../../src/number/branded-types/non-zero-int.mts"],"sourcesContent":["import { type NonZeroInt as TtfImported_NonZeroInt } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroInt = TtfImported_NonZeroInt;\n\ntype ElementType = NonZeroInt;\n\nconst typeNameInMessage = 'a non-zero integer';\n\nconst {\n  abs,\n  castType,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  number\n>({\n  integerOrSafeInteger: 'Integer',\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a NonZeroInt.\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonZeroInt, `false` otherwise.\n */\nexport const isNonZeroInt = is;\n\n/**\n * Casts a number to a NonZeroInt type.\n *\n * @param value The value to cast.\n * @returns The value as a NonZeroInt type.\n * @throws {TypeError} If the value is not a non-zero integer.\n */\nexport const asNonZeroInt = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for non-zero integers.\n *\n * All operations maintain the non-zero constraint, ensuring that results are\n * always valid NonZeroInt values. Division operations return floor division\n * results, and all arithmetic maintains integer precision.\n */\nexport const NonZeroInt = {\n  /**\n   * Type guard to check if a value is a NonZeroInt.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-zero integer, `false` otherwise.\n   */\n  is,\n\n  /**\n   * Returns the absolute value of a non-zero integer.\n   *\n   * @param a The non-zero integer.\n   * @returns The absolute value as a NonZeroInt.\n   */\n  abs,\n\n  /**\n   * Returns the smaller of two non-zero integers.\n   *\n   * @param a The first non-zero integer.\n   * @param b The second non-zero integer.\n   * @returns The minimum value as a NonZeroInt.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two non-zero integers.\n   *\n   * @param a The first non-zero integer.\n   * @param b The second non-zero integer.\n   * @returns The maximum value as a NonZeroInt.\n   */\n  max: max_,\n\n  /**\n   * Generates a random non-zero integer.\n   *\n   * @returns A random NonZeroInt value.\n   */\n  random,\n\n  /**\n   * Raises a non-zero integer to the power of another non-zero integer.\n   *\n   * @param a The base non-zero integer.\n   * @param b The exponent non-zero integer.\n   * @returns `a ** b` as a NonZeroInt.\n   */\n  pow,\n\n  /**\n   * Multiplies two non-zero integers.\n   *\n   * The product of two non-zero integers is always non-zero, so this stays\n   * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may\n   * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.\n   *\n   * @param a The first non-zero integer.\n   * @param b The second non-zero integer.\n   * @returns `a * b` as a NonZeroInt.\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int',\n    'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int', 'mul'>\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,oBAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,QAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,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,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAQH,MAAM,YAAA,GAAe;AASrB,MAAM,YAAA,GAAe;AASrB,MAAM,UAAA,GAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOxB,EAAA;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,EAOL,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA;AACF;;;;"}
+{"version":3,"file":"non-zero-int.mjs","sources":["../../../src/number/branded-types/non-zero-int.mts"],"sourcesContent":["import { type NonZeroInt as TtfImported_NonZeroInt } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonZeroInt = TtfImported_NonZeroInt;\n\ntype ElementType = NonZeroInt;\n\nconst typeNameInMessage = 'a non-zero integer';\n\nconst {\n  abs,\n  castType,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  randomNonZero: random,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  number,\n  number\n>({\n  integerOrSafeInteger: 'Integer',\n  nonZero: true,\n  MIN_VALUE: -Number.MAX_VALUE,\n  MAX_VALUE: Number.MAX_VALUE,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-zero integer.\n *\n * Returns `true` for a non-zero integer — a value with no fractional component,\n * including values outside the safe integer range (unlike `SafeInt`).\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-zero integer, `false` otherwise\n */\nexport const isNonZeroInt = is;\n\n/**\n * Casts a `number` to the `NonZeroInt` branded type.\n *\n * Validates that the value is a non-zero integer and returns it with the\n * `NonZeroInt` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonZeroInt`\n * @throws {TypeError} If the value is not a non-zero integer\n */\nexport const asNonZeroInt = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonZeroInt` branded type.\n *\n * The `NonZeroInt` type represents a non-zero integer. Division (`div`) uses\n * floor division.\n *\n * Unlike `SafeInt`, `NonZeroInt` allows values outside the safe integer range\n * (±2^53 − 1), so very large magnitudes may lose precision in JavaScript's\n * `number` type.\n */\nexport const NonZeroInt = {\n  /**\n   * Type guard that checks if a value is a non-zero integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-zero integer, `false` otherwise\n   * @see {@link isNonZeroInt} for usage examples\n   */\n  is,\n\n  /**\n   * Returns the absolute value of a non-zero integer.\n   *\n   * The result is non-negative and keeps the `NonZeroInt` brand. Note that\n   * `Math.abs(Number.MIN_SAFE_INTEGER)` exceeds `Number.MAX_SAFE_INTEGER`, so\n   * use `SafeInt` for guaranteed precision.\n   *\n   * @param a - The non-zero integer value\n   * @returns The absolute value as a non-negative `NonZeroInt`\n   */\n  abs,\n\n  /**\n   * Returns the smallest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The smallest value as a `NonZeroInt`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-zero integers.\n   *\n   * @param values - The non-zero integers to compare (at least one required)\n   * @returns The largest value as a `NonZeroInt`\n   */\n  max: max_,\n\n  /**\n   * Generates a random `NonZeroInt` 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 `NonZeroInt` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroInt` (floored\n   * to an integer).\n   *\n   * @param a - The base non-zero integer\n   * @param b - The exponent non-zero integer\n   * @returns `a ** b` as a `NonZeroInt`\n   */\n  pow,\n\n  /**\n   * Multiplies two non-zero integers, returning `a * b` as a `NonZeroInt`.\n   *\n   * @param a - The first non-zero integer\n   * @param b - The second non-zero integer\n   * @returns The product of `a` and `b` as a `NonZeroInt`\n   */\n  mul,\n} as const;\n\nexpectType<\n  keyof typeof NonZeroInt,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int',\n    'mul'\n  >\n>('=');\n\nexpectType<\n  typeof NonZeroInt,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int', 'mul'>\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,oBAAA;AAE1B,MAAM;AAAA,EACJ,GAAA;AAAA,EACA,QAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,aAAA,EAAe;AACjB,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,WAAW,MAAA,CAAO,SAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAWH,MAAM,YAAA,GAAe;AAYrB,MAAM,YAAA,GAAe;AAYrB,MAAM,UAAA,GAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQxB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,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;AAAA;AAAA,EAWL,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}

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

@@ -1,19 +1,24 @@
 import { type NonZeroInt16 as TtfImported_NonZeroInt16 } from 'ts-type-forge';
 export type NonZeroInt16 = TtfImported_NonZeroInt16;
 /**
- * Checks if a number is a NonZeroInt16 (16-bit non-zero signed integer in the
- * range [-2^15, 2^15) excluding 0).
+ * Type guard that checks if a value is a non-zero integer in [-2^15, 2^15).
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonZeroInt16, `false` otherwise.
+ * Returns `true` for a non-zero integer in [-2^15, 2^15) — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-zero integer in [-2^15, 2^15), `false` otherwise
  */
 export declare const isNonZeroInt16: (a: number) => a is TtfImported_NonZeroInt16;
 /**
- * Casts a number to a NonZeroInt16 type.
+ * Casts a `number` to the `NonZeroInt16` branded type.
+ *
+ * Validates that the value is a non-zero integer in [-2^15, 2^15) and returns
+ * it with the `NonZeroInt16` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonZeroInt16 type.
- * @throws {TypeError} If the value is not a non-zero integer in [-2^15, 2^15).
+ * @param value - The value to cast
+ * @returns The value as a `NonZeroInt16`
+ * @throws {TypeError} If the value is not a non-zero integer in [-2^15, 2^15)
  */
 export declare const asNonZeroInt16: <N extends number>(x: N) => number & {
     readonly "!=0": true;
@@ -33,90 +38,90 @@ export declare const asNonZeroInt16: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 16-bit non-zero
- * signed integers.
+ * Namespace providing type-safe operations for the `NonZeroInt16` branded type.
  *
- * All operations automatically clamp results to the valid NonZeroInt16 range
- * [-32768, 32767] excluding 0. This ensures that all arithmetic maintains the
- * 16-bit non-zero signed integer constraint, preventing zero results and
- * overflow.
+ * The `NonZeroInt16` type represents a non-zero integer in [-2^15, 2^15).
+ * Division (`div`) uses floor division.
  */
 export declare const NonZeroInt16: {
     /**
-     * Type guard to check if a value is a NonZeroInt16.
+     * Type guard that checks if a value is a non-zero integer in [-2^15, 2^15).
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a 16-bit non-zero signed integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-zero integer in [-2^15, 2^15), `false` otherwise
+     * @see {@link isNonZeroInt16} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonZeroInt16;
     /**
-     * The minimum value for a 16-bit non-zero signed integer.
-     *
-     * @readonly
+     * The smallest value representable as `NonZeroInt16` (the lower saturation
+     * target of `fromNumber`).
      */
     readonly MIN_VALUE: number;
     /**
-     * The maximum value for a 16-bit non-zero signed integer.
-     *
-     * @readonly
+     * The largest value representable as `NonZeroInt16` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the absolute value of a 16-bit non-zero signed integer.
+     * Returns the absolute value of a non-zero integer in [-2^15, 2^15).
      *
-     * @param a The NonZeroInt16 value.
-     * @returns The absolute value as a NonZeroInt16, clamped to valid range.
+     * The result is non-negative and keeps the `NonZeroInt16` brand.
+     *
+     * @param a - The non-zero integer value
+     * @returns The absolute value as a non-negative `NonZeroInt16`
      */
     readonly abs: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16>) => import("ts-type-forge").IntersectBrand<TtfImported_NonZeroInt16, import("ts-type-forge").PositiveNumber>;
     /**
-     * Returns the smaller of two NonZeroInt16 values.
+     * Returns the smallest of the given non-zero integers.
      *
-     * @param a The first NonZeroInt16.
-     * @param b The second NonZeroInt16.
-     * @returns The minimum value as a NonZeroInt16.
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The smallest value as a `NonZeroInt16`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16>[]) => TtfImported_NonZeroInt16;
     /**
-     * Returns the larger of two NonZeroInt16 values.
+     * Returns the largest of the given non-zero integers.
      *
-     * @param a The first NonZeroInt16.
-     * @param b The second NonZeroInt16.
-     * @returns The maximum value as a NonZeroInt16.
+     * @param values - The non-zero integers to compare (at least one required)
+     * @returns The largest value as a `NonZeroInt16`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16>[]) => TtfImported_NonZeroInt16;
     /**
-     * Clamps a number to the NonZeroInt16 range (avoiding zero).
+     * Converts an arbitrary `number` into a `NonZeroInt16`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asNonZeroInt16`, this is total: out-of-range inputs are clamped to
+     * the nearest representable `NonZeroInt16` instead of throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [-32768, 32767] \ {0} as a NonZeroInt16.
+     * @param value - The value to convert
+     * @returns The value as a `NonZeroInt16`
      */
-    readonly clamp: (x: number) => TtfImported_NonZeroInt16;
+    readonly fromNumber: (x: number) => TtfImported_NonZeroInt16;
     /**
-     * Generates a random NonZeroInt16 value within the valid range.
+     * Generates a random `NonZeroInt16` within the given range.
      *
-     * @returns A random NonZeroInt16 between MIN_VALUE and MAX_VALUE (excluding
-     *   0).
+     * The range is inclusive on both ends.
+     *
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonZeroInt16` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16> | undefined) => TtfImported_NonZeroInt16;
     /**
-     * Raises a NonZeroInt16 to the power of another NonZeroInt16.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonZeroInt16`
+     * (floored to an integer).
      *
-     * @param a The base NonZeroInt16.
-     * @param b The exponent NonZeroInt16.
-     * @returns `a ** b` clamped to [-32768, 32767] as a NonZeroInt16.
+     * @param a - The base non-zero integer
+     * @param b - The exponent non-zero integer
+     * @returns `a ** b` as a `NonZeroInt16`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16>) => TtfImported_NonZeroInt16;
     /**
-     * Multiplies two NonZeroInt16 values.
-     *
-     * The product of two non-zero integers is always non-zero, so this stays
-     * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
-     * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+     * Multiplies two non-zero integers, returning `a * b` as a `NonZeroInt16`.
      *
-     * @param a The first NonZeroInt16.
-     * @param b The second NonZeroInt16.
-     * @returns `a * b` clamped to [-32768, 32767] as a NonZeroInt16.
+     * @param a - The first non-zero integer
+     * @param b - The second non-zero integer
+     * @returns The product of `a` and `b` as a `NonZeroInt16`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonZeroInt16>) => TtfImported_NonZeroInt16;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-zero-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,IAAI,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAI9E,MAAM,MAAM,YAAY,GAAG,wBAAwB,CAAC;AA8BpD;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,8CAAK,CAAC;AAEjC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;MAAW,CAAC;AAEvC;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;;;;OAUG;;CAEK,CAAC"}
+{"version":3,"file":"non-zero-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-zero-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,IAAI,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAI9E,MAAM,MAAM,YAAY,GAAG,wBAAwB,CAAC;AA8BpD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,8CAAK,CAAC;AAEjC;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;MAAW,CAAC;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;;;OAOG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;CAEK,CAAC"}