ts-fortress
    Preparing search index...

    Variable NonZeroUint32

    NonZeroUint32: {
        add: (
            x: WithSmallInt<PositiveUint32, 40>,
            y: WithSmallInt<PositiveUint32, 40>,
        ) => PositiveUint32;
        fromNumber: (x: number) => PositiveUint32;
        is: (a: number) => a is PositiveUint32;
        max: (
            ...values: readonly WithSmallInt<PositiveUint32, 40>[],
        ) => PositiveUint32;
        MAX_VALUE: number;
        min: (
            ...values: readonly WithSmallInt<PositiveUint32, 40>[],
        ) => PositiveUint32;
        MIN_VALUE: 1;
        mul: (
            x: WithSmallInt<PositiveUint32, 40>,
            y: WithSmallInt<PositiveUint32, 40>,
        ) => PositiveUint32;
        pow: (
            x: WithSmallInt<PositiveUint32, 40>,
            y: WithSmallInt<PositiveUint32, 40>,
        ) => PositiveUint32;
        random: (
            min?: WithSmallInt<PositiveUint32, 40>,
            max?: WithSmallInt<PositiveUint32, 40>,
        ) => PositiveUint32;
    }

    Namespace providing type-safe operations for the NonZeroUint32 branded type.

    The NonZeroUint32 type represents a non-zero integer in [1, 2^32). Division (div) uses floor division.

    Type Declaration

    • Readonlyadd: (
          x: WithSmallInt<PositiveUint32, 40>,
          y: WithSmallInt<PositiveUint32, 40>,
      ) => PositiveUint32

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

    • ReadonlyfromNumber: (x: number) => PositiveUint32

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

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

    • Readonlyis: (a: number) => a is PositiveUint32

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

      isNonZeroUint32 for usage examples

    • Readonlymax: (...values: readonly WithSmallInt<PositiveUint32, 40>[]) => PositiveUint32

      Returns the largest of the given non-zero integers.

    • ReadonlyMAX_VALUE: number

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

    • Readonlymin: (...values: readonly WithSmallInt<PositiveUint32, 40>[]) => PositiveUint32

      Returns the smallest of the given non-zero integers.

    • ReadonlyMIN_VALUE: 1

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

    • Readonlymul: (
          x: WithSmallInt<PositiveUint32, 40>,
          y: WithSmallInt<PositiveUint32, 40>,
      ) => PositiveUint32

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

    • Readonlypow: (
          x: WithSmallInt<PositiveUint32, 40>,
          y: WithSmallInt<PositiveUint32, 40>,
      ) => PositiveUint32

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

    • Readonlyrandom: (
          min?: WithSmallInt<PositiveUint32, 40>,
          max?: WithSmallInt<PositiveUint32, 40>,
      ) => PositiveUint32

      Generates a random NonZeroUint32 within the given range.

      The range is inclusive on both ends.

    Settings
    Member Visibility