Utilities for working with ranges.

A range represents an interval—a set of values with a beginning and an end.

All functions in this module treat ranges as exclusive, but inclusive versions of all APIs are available in the Inclusive submodule.

from "range" include Range

Functions and constants included in the Range module.

inRange : (value: Number, range: Range<Number>) => Bool

Checks if the given number is within the range.

Parameters:

Returns:

Examples:

Range.inRange(1, { rangeStart: 0, rangeEnd: 2 }) == true

Range.inRange(10, { rangeStart: 0, rangeEnd: 2 }) == false

forEach : (fn: (Number => Void), range: Range<Number>) => Void

Calls the given function with each number in the range.

For increasing ranges, the value is increased by 1 in each iteration, and for decreasing ranges, the value is decreased by 1. The value is always changed by 1, even if non-integer values were provided in the range.

Parameters:

Examples:

Range.forEach(val => print(val), { rangeStart: 0, rangeEnd: 2 })

map : (fn: (Number => a), range: Range<Number>) => List<a>

Produces a list by calling the given function on each number included in the range.

For increasing ranges, the value is increased by 1 in each iteration, and for decreasing ranges, the value is decreased by 1. The value is always changed by 1, even if non-integer values were provided in the range.

Parameters:

Returns:

Examples:

Range.map(val => val * 2, { rangeStart: 0, rangeEnd: 3 }) == [0, 2, 4]

Functions and constants included in the Range.Inclusive module.

inRange : (value: Number, range: Range<Number>) => Bool

Checks if the given number is within the range.

Parameters:

Returns:

Examples:

Range.Inclusive.inRange(1, { rangeStart: 0, rangeEnd: 1 }) == true

Range.Inclusive.inRange(10, { rangeStart: 0, rangeEnd: 2 }) == false

forEach : (fn: (Number => Void), range: Range<Number>) => Void

Calls the given function with each number in the range.

For increasing ranges, the value is increased by 1 in each iteration, and for decreasing ranges, the value is decreased by 1. The value is always changed by 1, even if non-integer values were provided in the range.

Parameters:

Examples:

Range.Inclusive.forEach(val => print(val), { rangeStart: 0, rangeEnd: 2 })

map : (fn: (Number => a), range: Range<Number>) => List<a>

Produces a list by calling the given function on each number included in the range.

For increasing ranges, the value is increased by 1 in each iteration, and for decreasing ranges, the value is decreased by 1. The value is always changed by 1, even if non-integer values were provided in the range.

Parameters:

Returns:

Examples:

Range.Inclusive.map(val => val * 2, { rangeStart: 0, rangeEnd: 2 }) == [0, 2, 4]