Function inRange

  • inRange(number, start?, end?): boolean

  • Checks if number is between start and up to, but not including, end. If end is not specified, it's set to start with start then set to 0. If start is greater than end the params are swapped to support negative ranges.

    Parameters

    • number: number

      The number to check.

    • Optionalstart: number

      The start of the range.

    • Optionalend: number

      The end of the range.

    Returns boolean

    Returns true if number is in the range, else false.

    Since

    5.7.0

    See

    [[range]],[[rangeRight]]

    Example

    inRange(3, 2, 4)
    // => true

    inRange(4, 8)
    // => true

    inRange(4, 2)
    // => false

    inRange(2, 2)
    // => false

    inRange(1.2, 2)
    // => true

    inRange(5.2, 4)
    // => false

    inRange(-3, -2, -6)
    // => true

Settings

Member Visibility