Add segmentLength() method and deprecate some methods

Author: smikitky

README.md

@@ -93,20 +93,24 @@ To get the copy of the instance, use `clone()`, or alternatively the copy constr
 - `new MultiRange(data?: Initializer)` Creates a new MultiRange object.
 - `clone(): MultiRange` Clones this instance.
 - `append(value: Initializer): MultiRange` Appends to this instance.
-- `appendRange(min: number, max: number): MultiRange` Appends one range specified by the two parameters.
 - `subtract(value: Initializer): MultiRange` Subtracts from this instance.
-- `subtractRange(min: number, max: number): MultiRange` Subtracts one range specified by the two parameters.
 - `intersect(value: Initializer): MultiRange` Remove integers which are not included in `value` (aka intersection).
 - `has(value: Initializer): boolean` Checks if the instance contains the specified value.
-- `hasRange(min: number, max: number): boolean` Checks if the instance contains the range specified by the two parameters.
-- `isContinuous(): boolean` Checks if the current instance is continuous. Note that this returns false if the current range is empty.
-- `length(): number` Calculates how many numbers are effectively included in this instance. (`multirange('1-10,51-60,90').length()` returns 21)
+- `length(): number` Calculates how many numbers are effectively included in this instance. (ie, 5 for '3,5-7,9')
+- `segmentLength(): number` Returns the number of range segments (ie, 3 for '3,5-7,9' and 0 for an empty range)
 - `equals(cmp: Initializer): boolean` Checks if two MultiRange data are identical.
 - `toString(): string` Returns the string respresentation of this MultiRange.
 - `getRanges(): [number, number][]` Exports the whole range data as an array of [number, number] arrays.
 - `toArray(): number[]` Builds an array of integer which holds all integers in this MultiRange. Note that this may be slow and memory-consuming for large ranges such as '1-10000'.
 - `getIterator(): Object` Returns ES6-compatible iterator. See the description below.
 
+The following methods are deprecated and may be removed in future releases:
+
+- `appendRange(min: number, max: number): MultiRange` Use `append([[min, max]])` instead.
+- `subtractRange(min: number, max: number): MultiRange` Use `subtract([[min, max]])` instead.
+- `hasRange(min: number, max: number): boolean` Use `has([[min, max]])` instead.
+- `isContinuous(): boolean` Use `segmentLength() === 1` instead.
+
 ### Iteration
 
 **ES6 iterator**: If `Symbol.iterator` is defined in the runtime,

multi-integer-range.ts

@@ -87,6 +87,7 @@ export class MultiRange {
 	 * Appends a specified range of integers to this isntance.
 	 * @param min The minimum value of the range to append.
 	 * @param max The minimum value of the range to append.
+	 * @deprecated Use `.append([[min, max]])` instead.
 	 */
 	public appendRange(min: number, max: number): MultiRange {
 		let newRange: Range = [Math.max(0, min), max];
@@ -117,6 +118,7 @@ export class MultiRange {
 	 * Subtracts a specified range of integers from this instance.
 	 * @param min The minimum value of the range to subtract.
 	 * @param max The minimum value of the range to subtract.
+	 * @deprecated Use `.subtract([[min, max]])` instead.
 	 */
 	public subtractRange(min: number, max: number): MultiRange
 	{
@@ -275,16 +277,29 @@ export class MultiRange {
 	 * @param min The minimum value of the range to subtract.
 	 * @param max The minimum value of the range to subtract.
 	 * @return True if the specified value is included in the instance.
+	 * @deprecated Use `.has([[min, max]])` instead.
 	 */
 	public hasRange(min: number, max: number): boolean
 	{
 		return this.has(new MultiRange([[min, max]]));
 	}
 
+	/**
+	 * Returns the number of range segments.
+	 * For example, the segmentLength of `2-5,7,9-11' is 3.
+	 * Returns 0 for an empty instance.
+	 * @return The number of segments.
+	 */
+	public segmentLength(): number
+	{
+		return this.ranges.length;
+	}
+
 	/**
 	 * Checks if the current instance is continuous.
 	 * Note that this returns false if the current range is empty.
 	 * @return True if the current range is continuous.
+	 * @deprecated Use `.segmentLength() === 1` instead.
 	 */
 	public isContinuous(): boolean
 	{

test/multi-integer-range.js

@@ -216,6 +216,13 @@ describe('MultiRange', function() {
 		assert.equal(mr('1,3,10-15,20-21').length(), 10);
 	});
 
+	it('#segmentLength', function() {
+		assert.equal(mr('').segmentLength(), 0);
+		assert.equal(mr('5').segmentLength(), 1);
+		assert.equal(mr('5-10').segmentLength(), 1);
+		assert.equal(mr('1,3,10-15,20-21').segmentLength(), 4);
+	});
+
 	it('#equals', function() {
 		assert.isTrue(mr('').equals(''));
 		assert.isTrue(mr('5').equals(mr('5')));