ts-data-forge 11.0.0 → 12.0.0

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

@@ -5,8 +5,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -35,109 +35,121 @@ const isNonNegativeFiniteNumber = is;
 const asNonNegativeFiniteNumber = castType;
 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
    */
   is,
   /**
-   * The minimum value for a non-negative finite number.
-   *
-   * @readonly
+   * The smallest value representable as `NonNegativeFiniteNumber` (the lower
+   * saturation target of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * 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`
    */
   min: min_,
   /**
-   * 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`
    */
   max: max_,
   /**
-   * Clamps a number to the non-negative finite range.
+   * Converts an arbitrary `number` into a `NonNegativeFiniteNumber`, saturating
+   * it into the range `[MIN_VALUE, MAX_VALUE]`.
+   *
+   * Unlike `asNonNegativeFiniteNumber`, this is total: out-of-range inputs are
+   * clamped to the nearest representable `NonNegativeFiniteNumber` instead of
+   * throwing.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, +∞) as a NonNegativeFiniteNumber.
+   * @param value - The value to convert
+   * @returns The value as a `NonNegativeFiniteNumber`
    */
-  clamp,
+  fromNumber,
   /**
-   * 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
    */
   floor,
   /**
-   * 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
    */
   ceil,
   /**
-   * 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
    */
   round,
   /**
-   * 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]`
    */
   random,
   /**
-   * 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`
    */
   pow,
   /**
-   * 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`
    */
   add,
   /**
-   * 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`
    */
   sub,
   /**
-   * 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`
    */
   mul,
   /**
-   * 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`
    */
   div
 };

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

@@ -1 +1 @@
-{"version":3,"file":"non-negative-finite-number.mjs","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"sourcesContent":["import {\n  type NonNegativeFiniteNumber as TtfImported_NonNegativeFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeFiniteNumber = TtfImported_NonNegativeFiniteNumber;\n\ntype ElementType = NonNegativeFiniteNumber;\n\nconst typeNameInMessage = 'a non-negative finite number';\n\nconst {\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  0,\n  number\n>({\n  MIN_VALUE: 0,\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<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Uint>(\n  '=',\n);\n\n/**\n * Checks if a number is a NonNegativeFiniteNumber (a finite number >= 0).\n *\n * @param value The value to check.\n * @returns `true` if the value is a NonNegativeFiniteNumber, `false` otherwise.\n */\nexport const isNonNegativeFiniteNumber = is;\n\n/**\n * Casts a number to a NonNegativeFiniteNumber type.\n *\n * @param value The value to cast.\n * @returns The value as a NonNegativeFiniteNumber type.\n * @throws {TypeError} If the value is not a non-negative finite number.\n */\nexport const asNonNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for non-negative finite\n * numbers.\n *\n * All operations maintain the non-negative constraint by clamping negative\n * results to 0, while ensuring results remain finite (excluding NaN and\n * Infinity). This type is useful for representing measurements, distances,\n * weights, and other inherently non-negative values.\n */\nexport const NonNegativeFiniteNumber = {\n  /**\n   * Type guard to check if a value is a NonNegativeFiniteNumber.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-negative finite number, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a non-negative finite number.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smaller of two NonNegativeFiniteNumber values.\n   *\n   * @param a The first NonNegativeFiniteNumber.\n   * @param b The second NonNegativeFiniteNumber.\n   * @returns The minimum value as a NonNegativeFiniteNumber.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two NonNegativeFiniteNumber values.\n   *\n   * @param a The first NonNegativeFiniteNumber.\n   * @param b The second NonNegativeFiniteNumber.\n   * @returns The maximum value as a NonNegativeFiniteNumber.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the non-negative finite range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  clamp,\n\n  /**\n   * Rounds down a NonNegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NonNegativeFiniteNumber to round down.\n   * @returns The floor value as a Uint.\n   */\n  floor,\n\n  /**\n   * Rounds up a NonNegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NonNegativeFiniteNumber to round up.\n   * @returns The ceiling value as a Uint.\n   */\n  ceil,\n\n  /**\n   * Rounds a NonNegativeFiniteNumber to the nearest integer.\n   *\n   * @param x The NonNegativeFiniteNumber to round.\n   * @returns The rounded value as a Uint.\n   */\n  round,\n\n  /**\n   * Generates a random NonNegativeFiniteNumber value.\n   *\n   * @returns A random non-negative finite number.\n   */\n  random,\n\n  /**\n   * Raises a NonNegativeFiniteNumber to the power of another\n   * NonNegativeFiniteNumber.\n   *\n   * @param a The base NonNegativeFiniteNumber.\n   * @param b The exponent NonNegativeFiniteNumber.\n   * @returns `a ** b` clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  pow,\n\n  /**\n   * Adds two NonNegativeFiniteNumber values.\n   *\n   * @param a The first NonNegativeFiniteNumber.\n   * @param b The second NonNegativeFiniteNumber.\n   * @returns `a + b` clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  add,\n\n  /**\n   * Subtracts one NonNegativeFiniteNumber from another.\n   *\n   * @param a The minuend NonNegativeFiniteNumber.\n   * @param b The subtrahend NonNegativeFiniteNumber.\n   * @returns `a - b` clamped to [0, +∞) as a NonNegativeFiniteNumber (minimum\n   *   0).\n   */\n  sub,\n\n  /**\n   * Multiplies two NonNegativeFiniteNumber values.\n   *\n   * @param a The first NonNegativeFiniteNumber.\n   * @param b The second NonNegativeFiniteNumber.\n   * @returns `a * b` clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  mul,\n\n  /**\n   * Divides one NonNegativeFiniteNumber by another.\n   *\n   * @param a The dividend NonNegativeFiniteNumber.\n   * @param b The divisor NonNegativeFiniteNumber.\n   * @returns `a / b` clamped to [0, +∞) as a NonNegativeFiniteNumber.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,CAAA;AAAA,EACX,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;AAYP,MAAM,yBAAA,GAA4B;AASlC,MAAM,yBAAA,GAA4B;AAWlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,EAAA;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,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;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,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}
+{"version":3,"file":"non-negative-finite-number.mjs","sources":["../../../src/number/branded-types/non-negative-finite-number.mts"],"sourcesContent":["import {\n  type NonNegativeFiniteNumber as TtfImported_NonNegativeFiniteNumber,\n  type Uint,\n} from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type NonNegativeFiniteNumber = TtfImported_NonNegativeFiniteNumber;\n\ntype ElementType = NonNegativeFiniteNumber;\n\nconst typeNameInMessage = 'a non-negative finite number';\n\nconst {\n  MIN_VALUE,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<\n  ElementType,\n  0,\n  number\n>({\n  MIN_VALUE: 0,\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<TsDataForgeInternals.RefinedNumberUtils.ToInt<ElementType>, Uint>(\n  '=',\n);\n\n/**\n * Type guard that checks if a value is a non-negative 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-negative finite number, `false` otherwise\n */\nexport const isNonNegativeFiniteNumber = is;\n\n/**\n * Casts a `number` to the `NonNegativeFiniteNumber` branded type.\n *\n * Validates that the value is a non-negative finite number and returns it with\n * the `NonNegativeFiniteNumber` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `NonNegativeFiniteNumber`\n * @throws {TypeError} If the value is not a non-negative finite number\n */\nexport const asNonNegativeFiniteNumber = castType;\n\n/**\n * Namespace providing type-safe operations for the `NonNegativeFiniteNumber`\n * branded type.\n *\n * The `NonNegativeFiniteNumber` type represents a non-negative finite number.\n */\nexport const NonNegativeFiniteNumber = {\n  /**\n   * Type guard that checks if a value is a non-negative finite number.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative finite number, `false` otherwise\n   * @see {@link isNonNegativeFiniteNumber} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `NonNegativeFiniteNumber` (the lower\n   * saturation target of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative finite numbers.\n   *\n   * @param values - The non-negative finite numbers to compare (at least one required)\n   * @returns The smallest value as a `NonNegativeFiniteNumber`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative finite numbers.\n   *\n   * @param values - The non-negative finite numbers to compare (at least one required)\n   * @returns The largest value as a `NonNegativeFiniteNumber`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `NonNegativeFiniteNumber`, saturating\n   * it into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asNonNegativeFiniteNumber`, this is total: out-of-range inputs are\n   * clamped to the nearest representable `NonNegativeFiniteNumber` instead of\n   * throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `NonNegativeFiniteNumber`\n   */\n  fromNumber,\n\n  /**\n   * Returns the greatest integer less than or equal to a non-negative finite\n   * number.\n   *\n   * @param a - The non-negative 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-negative finite\n   * number.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The ceiled value as an integer\n   */\n  ceil,\n\n  /**\n   * Returns the value of a non-negative finite number rounded to the nearest\n   * integer.\n   *\n   * @param a - The non-negative finite number value\n   * @returns The rounded value as an integer\n   */\n  round,\n\n  /**\n   * Generates a random `NonNegativeFiniteNumber` 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 `NonNegativeFiniteNumber` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The base non-negative finite number\n   * @param b - The exponent non-negative finite number\n   * @returns `a ** b` as a `NonNegativeFiniteNumber`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative finite numbers, returning `a + b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The sum of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative finite numbers, returning `a - b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The difference of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative finite numbers, returning `a * b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The first non-negative finite number\n   * @param b - The second non-negative finite number\n   * @returns The product of `a` and `b` as a `NonNegativeFiniteNumber`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative finite numbers, returning `a / b` as a\n   * `NonNegativeFiniteNumber`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns `a / b` as a `NonNegativeFiniteNumber`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof NonNegativeFiniteNumber,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('=');\n\nexpectType<\n  typeof NonNegativeFiniteNumber,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'non-negative'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAWA,MAAM,iBAAA,GAAoB,8BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,iBAAA,CAI1C;AAAA,EACA,SAAA,EAAW,CAAA;AAAA,EACX,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;AAeP,MAAM,yBAAA,GAA4B;AAYlC,MAAM,yBAAA,GAA4B;AAQlC,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,EAAA;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,EAaL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}

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

@@ -1,19 +1,24 @@
 import { type NonNegativeInt16 as TtfImported_NonNegativeInt16 } from 'ts-type-forge';
 export type NonNegativeInt16 = TtfImported_NonNegativeInt16;
 /**
- * Checks if a number is a NonNegativeInt16 (16-bit non-negative signed integer
- * in the range [0, 2^15)).
+ * Type guard that checks if a value is a non-negative integer in [0, 2^15).
  *
- * @param value The value to check.
- * @returns `true` if the value is a NonNegativeInt16, `false` otherwise.
+ * Returns `true` for a non-negative integer in [0, 2^15) — a value with no
+ * fractional component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative integer in [0, 2^15), `false` otherwise
  */
 export declare const isNonNegativeInt16: (a: number) => a is TtfImported_NonNegativeInt16;
 /**
- * Casts a number to a NonNegativeInt16 type.
+ * Casts a `number` to the `NonNegativeInt16` branded type.
+ *
+ * Validates that the value is a non-negative integer in [0, 2^15) and returns
+ * it with the `NonNegativeInt16` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a NonNegativeInt16 type.
- * @throws {TypeError} If the value is not a non-negative integer in [0, 2^15).
+ * @param value - The value to cast
+ * @returns The value as a `NonNegativeInt16`
+ * @throws {TypeError} If the value is not a non-negative integer in [0, 2^15)
  */
 export declare const asNonNegativeInt16: <N extends number>(x: N) => number & {
     readonly "< 2^15": true;
@@ -33,102 +38,110 @@ export declare const asNonNegativeInt16: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for 16-bit non-negative
- * integers.
+ * Namespace providing type-safe operations for the `NonNegativeInt16` branded
+ * type.
  *
- * All operations automatically clamp results to the valid NonNegativeInt16
- * range [0, 32767]. This ensures that all arithmetic maintains the 16-bit
- * non-negative integer constraint, with negative results clamped to 0 and
- * overflow results clamped to MAX_VALUE.
+ * The `NonNegativeInt16` type represents a non-negative integer in [0, 2^15).
+ * Division (`div`) uses floor division.
  */
 export declare const NonNegativeInt16: {
     /**
-     * Type guard to check if a value is a NonNegativeInt16.
+     * Type guard that checks if a value is a non-negative integer in [0, 2^15).
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a 16-bit non-negative integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-negative integer in [0, 2^15), `false` otherwise
+     * @see {@link isNonNegativeInt16} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_NonNegativeInt16;
     /**
-     * The minimum value for a 16-bit non-negative integer.
-     *
-     * @readonly
+     * The smallest value representable as `NonNegativeInt16` (the lower
+     * saturation target of `fromNumber`).
      */
     readonly MIN_VALUE: 0;
     /**
-     * The maximum value for a 16-bit non-negative integer.
-     *
-     * @readonly
+     * The largest value representable as `NonNegativeInt16` (the upper saturation
+     * target of `fromNumber`).
      */
     readonly MAX_VALUE: number;
     /**
-     * Returns the smaller of two NonNegativeInt16 values.
+     * Returns the smallest of the given non-negative integers.
      *
-     * @param a The first NonNegativeInt16.
-     * @param b The second NonNegativeInt16.
-     * @returns The minimum value as a NonNegativeInt16.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The smallest value as a `NonNegativeInt16`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>[]) => TtfImported_NonNegativeInt16;
     /**
-     * Returns the larger of two NonNegativeInt16 values.
+     * Returns the largest of the given non-negative integers.
      *
-     * @param a The first NonNegativeInt16.
-     * @param b The second NonNegativeInt16.
-     * @returns The maximum value as a NonNegativeInt16.
+     * @param values - The non-negative integers to compare (at least one required)
+     * @returns The largest value as a `NonNegativeInt16`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>[]) => TtfImported_NonNegativeInt16;
     /**
-     * Clamps a number to the NonNegativeInt16 range.
+     * Converts an arbitrary `number` into a `NonNegativeInt16`, rounding to the
+     * nearest integer and saturating the result into the range `[MIN_VALUE,
+     * MAX_VALUE]`.
+     *
+     * Unlike `asNonNegativeInt16`, this is total: out-of-range inputs are clamped
+     * to the nearest representable `NonNegativeInt16` instead of throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, 32767] as a NonNegativeInt16.
+     * @param value - The value to convert
+     * @returns The value as a `NonNegativeInt16`
      */
-    readonly clamp: (x: number) => TtfImported_NonNegativeInt16;
+    readonly fromNumber: (x: number) => TtfImported_NonNegativeInt16;
     /**
-     * Generates a random NonNegativeInt16 value within the valid range.
+     * Generates a random `NonNegativeInt16` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random NonNegativeInt16 between 0 and 32767.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `NonNegativeInt16` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16> | undefined) => TtfImported_NonNegativeInt16;
     /**
-     * Raises a NonNegativeInt16 to the power of another NonNegativeInt16.
+     * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt16`
+     * (floored to an integer).
      *
-     * @param a The base NonNegativeInt16.
-     * @param b The exponent NonNegativeInt16.
-     * @returns `a ** b` clamped to [0, 32767] as a NonNegativeInt16.
+     * @param a - The base non-negative integer
+     * @param b - The exponent non-negative integer
+     * @returns `a ** b` as a `NonNegativeInt16`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>) => TtfImported_NonNegativeInt16;
     /**
-     * Adds two NonNegativeInt16 values.
+     * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt16`.
      *
-     * @param a The first NonNegativeInt16.
-     * @param b The second NonNegativeInt16.
-     * @returns `a + b` clamped to [0, 32767] as a NonNegativeInt16.
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The sum of `a` and `b` as a `NonNegativeInt16`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>) => TtfImported_NonNegativeInt16;
     /**
-     * Subtracts one NonNegativeInt16 from another.
+     * Subtracts two non-negative integers, returning `a - b` as a
+     * `NonNegativeInt16`.
      *
-     * @param a The minuend NonNegativeInt16.
-     * @param b The subtrahend NonNegativeInt16.
-     * @returns `a - b` clamped to [0, 32767] as a NonNegativeInt16 (minimum 0).
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The difference of `a` and `b` as a `NonNegativeInt16`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>) => TtfImported_NonNegativeInt16;
     /**
-     * Multiplies two NonNegativeInt16 values.
+     * Multiplies two non-negative integers, returning `a * b` as a
+     * `NonNegativeInt16`.
      *
-     * @param a The first NonNegativeInt16.
-     * @param b The second NonNegativeInt16.
-     * @returns `a * b` clamped to [0, 32767] as a NonNegativeInt16.
+     * @param a - The first non-negative integer
+     * @param b - The second non-negative integer
+     * @returns The product of `a` and `b` as a `NonNegativeInt16`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>, y: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>) => TtfImported_NonNegativeInt16;
     /**
-     * Divides one NonNegativeInt16 by another using floor division.
+     * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+     * result is `a / b` rounded toward negative infinity, as a
+     * `NonNegativeInt16`.
      *
-     * @param a The dividend NonNegativeInt16.
-     * @param b The divisor NonNegativeInt16.
-     * @returns `⌊a / b⌋` clamped to [0, 32767] as a NonNegativeInt16.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as a `NonNegativeInt16`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_NonNegativeInt16>, y: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
         readonly "!=0": true;

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

@@ -1 +1 @@
-{"version":3,"file":"non-negative-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,IAAI,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAItF,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AA+B5D;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,kDAAK,CAAC;AAErC;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;MAAW,CAAC;AAE3C;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"non-negative-int16.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/non-negative-int16.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,IAAI,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAItF,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;AA+B5D;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,kDAAK,CAAC;AAErC;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;MAAW,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;;OAUG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;;OAQG;;;;;;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/non-negative-int16.mjs

@@ -6,8 +6,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -25,92 +25,102 @@ const isNonNegativeInt16 = is;
 const asNonNegativeInt16 = castType;
 const NonNegativeInt16 = {
   /**
-   * Type guard to check if a value is a NonNegativeInt16.
+   * Type guard that checks if a value is a non-negative integer in [0, 2^15).
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a 16-bit non-negative integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-negative integer in [0, 2^15), `false` otherwise
+   * @see {@link isNonNegativeInt16} for usage examples
    */
   is,
   /**
-   * The minimum value for a 16-bit non-negative integer.
-   *
-   * @readonly
+   * The smallest value representable as `NonNegativeInt16` (the lower
+   * saturation target of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum value for a 16-bit non-negative integer.
-   *
-   * @readonly
+   * The largest value representable as `NonNegativeInt16` (the upper saturation
+   * target of `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two NonNegativeInt16 values.
+   * Returns the smallest of the given non-negative integers.
    *
-   * @param a The first NonNegativeInt16.
-   * @param b The second NonNegativeInt16.
-   * @returns The minimum value as a NonNegativeInt16.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The smallest value as a `NonNegativeInt16`
    */
   min: min_,
   /**
-   * Returns the larger of two NonNegativeInt16 values.
+   * Returns the largest of the given non-negative integers.
    *
-   * @param a The first NonNegativeInt16.
-   * @param b The second NonNegativeInt16.
-   * @returns The maximum value as a NonNegativeInt16.
+   * @param values - The non-negative integers to compare (at least one required)
+   * @returns The largest value as a `NonNegativeInt16`
    */
   max: max_,
   /**
-   * Clamps a number to the NonNegativeInt16 range.
+   * Converts an arbitrary `number` into a `NonNegativeInt16`, 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 [0, 32767] as a NonNegativeInt16.
+   * Unlike `asNonNegativeInt16`, this is total: out-of-range inputs are clamped
+   * to the nearest representable `NonNegativeInt16` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `NonNegativeInt16`
    */
-  clamp,
+  fromNumber,
   /**
-   * Generates a random NonNegativeInt16 value within the valid range.
+   * Generates a random `NonNegativeInt16` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random NonNegativeInt16 between 0 and 32767.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `NonNegativeInt16` in `[min, max]`
    */
   random,
   /**
-   * Raises a NonNegativeInt16 to the power of another NonNegativeInt16.
+   * Raises `a` to the power `b`, returning `a ** b` as a `NonNegativeInt16`
+   * (floored to an integer).
    *
-   * @param a The base NonNegativeInt16.
-   * @param b The exponent NonNegativeInt16.
-   * @returns `a ** b` clamped to [0, 32767] as a NonNegativeInt16.
+   * @param a - The base non-negative integer
+   * @param b - The exponent non-negative integer
+   * @returns `a ** b` as a `NonNegativeInt16`
    */
   pow,
   /**
-   * Adds two NonNegativeInt16 values.
+   * Adds two non-negative integers, returning `a + b` as a `NonNegativeInt16`.
    *
-   * @param a The first NonNegativeInt16.
-   * @param b The second NonNegativeInt16.
-   * @returns `a + b` clamped to [0, 32767] as a NonNegativeInt16.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The sum of `a` and `b` as a `NonNegativeInt16`
    */
   add,
   /**
-   * Subtracts one NonNegativeInt16 from another.
+   * Subtracts two non-negative integers, returning `a - b` as a
+   * `NonNegativeInt16`.
    *
-   * @param a The minuend NonNegativeInt16.
-   * @param b The subtrahend NonNegativeInt16.
-   * @returns `a - b` clamped to [0, 32767] as a NonNegativeInt16 (minimum 0).
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The difference of `a` and `b` as a `NonNegativeInt16`
    */
   sub,
   /**
-   * Multiplies two NonNegativeInt16 values.
+   * Multiplies two non-negative integers, returning `a * b` as a
+   * `NonNegativeInt16`.
    *
-   * @param a The first NonNegativeInt16.
-   * @param b The second NonNegativeInt16.
-   * @returns `a * b` clamped to [0, 32767] as a NonNegativeInt16.
+   * @param a - The first non-negative integer
+   * @param b - The second non-negative integer
+   * @returns The product of `a` and `b` as a `NonNegativeInt16`
    */
   mul,
   /**
-   * Divides one NonNegativeInt16 by another using floor division.
+   * Divides two non-negative integers using floor division (`⌊a / b⌋`): the
+   * result is `a / b` rounded toward negative infinity, as a
+   * `NonNegativeInt16`.
    *
-   * @param a The dividend NonNegativeInt16.
-   * @param b The divisor NonNegativeInt16.
-   * @returns `⌊a / b⌋` clamped to [0, 32767] as a NonNegativeInt16.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `NonNegativeInt16`
    */
   div
 };