ts-data-forge
    Preparing search index...

    Function isUintInRange

    • Creates a type guard that checks if a number is an unsigned integer within a specified range.

      This function returns a predicate that validates whether a number is:

      • A safe integer (no floating point)
      • Within the range [lowerBound, upperBound)

      The returned type guard provides precise type narrowing when the bounds are SmallUint literals, making it ideal for array index validation.

      Type Parameters

      • L extends
            | 0
            | 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

        The lower bound as a SmallUint literal type

      • U extends
            | 0
            | 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

        The upper bound as a SmallUint literal type

      Parameters

      • lowerBound: L

        The minimum value (inclusive)

      • upperBound: U

        The maximum value (exclusive)

      Returns (
          x: number,
      ) => x is RelaxedExclude<
          Readonly<
              {
                  "0": never;
                  "1": 0;
                  "10": 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
                  "11": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
                  "12": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
                  "13": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
                  "14": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13;
                  "15": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14;
                  "16": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
                  "17":
                      | 0
                      | 1
                      | 2
                      | 3
                      | 4
                      | 5
                      | 6
                      | 7
                      | 8
                      | 9
                      | 10
                      | 11
                      | 12
                      | 13
                      | 14
                      | 15
                      | 16;
                  "18": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17;
                  "19": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18;
                  "2": 0
                  | 1;
                  "20":
                      | 0
                      | 1
                      | 2
                      | 3
                      | 4
                      | 5
                      | 6
                      | 7
                      | 8
                      | 9
                      | 10
                      | 11
                      | 12
                      | 13
                      | 14
                      | 15
                      | 16
                      | 17
                      | 18
                      | 19;
                  "21": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20;
                  "22": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20
                  | 21;
                  "23": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20
                  | 21
                  | 22;
                  "24": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20
                  | 21
                  | 22
                  | 23;
                  "25": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20
                  | 21
                  | 22
                  | 23
                  | 24;
                  "26": | 0
                  | 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;
                  "27": | 0
                  | 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;
                  "28": | 0
                  | 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;
                  "29": | 0
                  | 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;
                  "3": 0
                  | 1
                  | 2;
                  "30":
                      | 0
                      | 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;
                  "31": | 0
                  | 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;
                  "32": | 0
                  | 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;
                  "33": | 0
                  | 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;
                  "34": | 0
                  | 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;
                  "35": | 0
                  | 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;
                  "36": | 0
                  | 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;
                  "37": | 0
                  | 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;
                  "38": | 0
                  | 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;
                  "39": | 0
                  | 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;
                  "4": 0
                  | 1
                  | 2
                  | 3;
                  "5": 0 | 1 | 2 | 3 | 4;
                  "6": 0 | 1 | 2 | 3 | 4 | 5;
                  "7": 0 | 1 | 2 | 3 | 4 | 5 | 6;
                  "8": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
                  "9": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
              },
          >[U],
          Readonly<
              {
                  "0": never;
                  "1": 0;
                  "10": 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
                  "11": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
                  "12": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
                  "13": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
                  "14": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13;
                  "15": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14;
                  "16": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
                  "17":
                      | 0
                      | 1
                      | 2
                      | 3
                      | 4
                      | 5
                      | 6
                      | 7
                      | 8
                      | 9
                      | 10
                      | 11
                      | 12
                      | 13
                      | 14
                      | 15
                      | 16;
                  "18": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17;
                  "19": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18;
                  "2": 0
                  | 1;
                  "20":
                      | 0
                      | 1
                      | 2
                      | 3
                      | 4
                      | 5
                      | 6
                      | 7
                      | 8
                      | 9
                      | 10
                      | 11
                      | 12
                      | 13
                      | 14
                      | 15
                      | 16
                      | 17
                      | 18
                      | 19;
                  "21": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20;
                  "22": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20
                  | 21;
                  "23": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20
                  | 21
                  | 22;
                  "24": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20
                  | 21
                  | 22
                  | 23;
                  "25": | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12
                  | 13
                  | 14
                  | 15
                  | 16
                  | 17
                  | 18
                  | 19
                  | 20
                  | 21
                  | 22
                  | 23
                  | 24;
                  "26": | 0
                  | 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;
                  "27": | 0
                  | 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;
                  "28": | 0
                  | 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;
                  "29": | 0
                  | 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;
                  "3": 0
                  | 1
                  | 2;
                  "30":
                      | 0
                      | 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;
                  "31": | 0
                  | 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;
                  "32": | 0
                  | 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;
                  "33": | 0
                  | 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;
                  "34": | 0
                  | 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;
                  "35": | 0
                  | 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;
                  "36": | 0
                  | 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;
                  "37": | 0
                  | 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;
                  "38": | 0
                  | 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;
                  "39": | 0
                  | 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;
                  "4": 0
                  | 1
                  | 2
                  | 3;
                  "5": 0 | 1 | 2 | 3 | 4;
                  "6": 0 | 1 | 2 | 3 | 4 | 5;
                  "7": 0 | 1 | 2 | 3 | 4 | 5 | 6;
                  "8": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
                  "9": 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
              },
          >[MinImpl<L, []>],
      >

      A type guard function that validates and narrows number types

      const indexGuard = Num.isUintInRange(0, 5);

      assert.isTrue(indexGuard(3));

      assert.isFalse(indexGuard(5));

      assert.isFalse(indexGuard(-1));

    Settings

    Member Visibility