Variable NonZeroUint16

Type Declaration

• add: (x: WithSmallInt, y: WithSmallInt) => PositiveUint16

  Adds two non-zero integers, returning a + b as a NonZeroUint16.

• fromNumber: (x: number) => PositiveUint16

  Converts an arbitrary number into a NonZeroUint16, rounding to the nearest integer and saturating the result into the range [MIN_VALUE, MAX_VALUE].

  Unlike asNonZeroUint16, this is total: out-of-range inputs are clamped to the nearest representable NonZeroUint16 instead of throwing.

• is: (a: number) => a is PositiveUint16

  Type guard that checks if a value is a non-zero integer in [1, 2^16).

  See

  isNonZeroUint16 for usage examples

• Readonlymax: (...values: readonly WithSmallInt<PositiveUint16>[]) => PositiveUint16

  Returns the largest of the given non-zero integers.

• MAX_VALUE: number

  The largest value representable as NonZeroUint16 (the upper saturation target of fromNumber).

• Readonlymin: (...values: readonly WithSmallInt<PositiveUint16>[]) => PositiveUint16

  Returns the smallest of the given non-zero integers.

• MIN_VALUE: 1

  The smallest value representable as NonZeroUint16 (the lower saturation target of fromNumber).

• mul: (x: WithSmallInt, y: WithSmallInt) => PositiveUint16

  Multiplies two non-zero integers, returning a * b as a NonZeroUint16.

• pow: (x: WithSmallInt, y: WithSmallInt) => PositiveUint16

  Raises a to the power b, returning a ** b as a NonZeroUint16 (floored to an integer).

• random: (
      min?: WithSmallInt<PositiveUint16>,
      max?: WithSmallInt<PositiveUint16>,
  ) => PositiveUint16

  Generates a random NonZeroUint16 within the given range.

  The range is inclusive on both ends.