SparseRangeObject

class SparseRangeObject(arg, rangeObject)

A sparse range object contains many {@link RangeObject}s. The range objects are stored as arrays and then are concatenated into one array in the order that they were supplied to the constructor.

Arguments:
  • arg (RangeObject|Array.<RangeObject>|object) – First range object, or array of range objects, or object with sparse key containing an array of range objects.

  • rangeObject (RangeObject) – If first argument is a RangeObject, subsquent arguments are range objects too.

Examples:

r0 = new RangeObject(1,2)
r1 = new RangeObject(1,3)
sro = new SparseRangeObject(r0, r1)
// [ 1, 2, 1, 2, 3]

Example

const r0 = new RangeObject(1, 2);
const r1 = new RangeObject(1, 3);
const sro = new SparseRangeObject(r0, r1);
sro.toArray();
// [ 1, 2, 1, 2, 3 ]

Properties

length

SparseRangeObject.length
Type:

number

The total number of values across all constituent ranges (the sum of each range’s own length).

Methods

filter

See SuperRangeObject.filter()

slice

See SuperRangeObject.slice()

nthValue

SparseRangeObject.nthValue(n)

Return nth value in range

Arguments:
  • n (number)

Examples:

let sparseRangeObject = new SparseRangeObject(1,3,1);
rangeObject.toArray();
// [ 1, 2, 3]
rangeObject.nthValue(1);
// 2

toObject

SparseRangeObject.toObject()

Create object literal with sparse property and range property containing array of range objects.