Package Exports

multi-integer-range

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (multi-integer-range) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

multi-integer-range

A library which parses and manipulates comma-delimited positive integer ranges (such as "1-3,8-10").

Such strings are typically used in print dialogs to indicate which pages to print.

Supported operations include

Addition (e.g., '1-2' + '3-5' => '1-5')
Subtraction (e.g., '1-10' - '5-9' => '1-4,10')
Inclusion check (e.g., '5' in '1-10')
Array creation

Internal data are always sorted and normalized to the smallest possible representation.

Usage

Install via npm: npm install multi-integer-range

Initialization

Initialization can be done with an integer array, a string, or another MultiRange instance. A shorthand constructor function multirange() is also available. Use whichever you prefer.

var MultiRange = require('multi-integer-range').MultiRange;

var mr1 = new MultiRange([7, 2, 9, 1, 8, 3]);
var mr2 = new MultiRange('1-2, 3, 7-9');
var mr3 = new MultiRange(mr1);

// function-style
var multirange = require('multi-integer-range').multirange;
var mr4 = multirange('1,2,3,7,8,9'); // the same as `new MultiRange`

Internal data are always sorted and normalized, so the above four (mr1-mr4) hold a instance with identical range data.

The string parser is permissive and accepts space characters before/after comma/hyphens. Order is not important either, and overlapped numbers are silently ignored.

var mr = new MultiRange('3,\t8-3,2,3,\n10, 9 - 7 ');
console.log(mr.toString()); // prints '2-10'

Manipulation and Comparison

var mr = new MultiRange('1-3,7-9');

// Addition
mr.append('4-5')
  .append(6)
  .append(new MultiRange('10-11'))
  .appendRange(12, 15); // append 12-15

console.log('' + mr); // prints '1-15'

// Subtraction
mr.subtract('2-8');
console.log('' + mr); // prints '1,9-15'

// Equality check
console.log(mr.equals('1,9-12,13,14,15')); // true

// Inclusion check
console.log(mr.has(10)); // true
console.log(mr.has(100)); // false

// Length (the total number of integers)
console.log(mr.length()); // 10

// Continuity
console.log(mr.isContinuous()); // false

Output

There are several ways to get the content of the MultiRange object.

var mr = new MultiRange([1,2,3,5,6,7,8]);

// As a string
console.log(mr.toString()); // '1-3,5-8'

// Or concat an empty string to implicitly call #toString()
console.log('' + mr); // '1-3,5-8'

// As an array which holds every integer (of course slow for large range)
console.log(mr.toArray()); // [1,2,3,5,6,7,8]

// As an array of 2-element arrays
console.log(mr.getRanges()); // [[1,3],[5,8]]

Iteration

ES6 iterator: If Symbol.iterator is defined in the runtime, you can simply iterate over the instance using the for ... of statement:

for (let page of multirange('2,5-7')) {
    console.log(page);
}
// prints 2, 5, 6, 7

If Symbol.iterator is not defined, you can still access the iterator implementation and use it manually like this:

var it = multirange('2,5-7').getIterator(),
    page;
while (!(page = it.next()).done) {
    console.log(page.value);
}

Use in Browsers

This library should be Browserify-friendly.

Development

Building and Testing

npm install
npm run-script build
npm test

Bugs

Use GitHub issues.

Author

Soichiro Miki (https://github.com/smikitky)

License

MIT