natural-range
v1.0.0
Published
Convert any range to an exclusive range in natural order.
Downloads
42
Readme
natural-range
Convert any range to an exclusive range in natural order.
Installation
npm install natural-range
Example
var assert = require('assert');
var Range = require('natural-range');
var range = new Range({ from: 3, to: 1 });
assert.equal(range.from, 1);
assert.equal(range.to, 4);
assert.equal(range.reversed, true);
See test/test.js
for more examples.
API
var range = new Range(options);
options
- an object literal supports these options:from
- the start numberto
- the end numberexclusive
- a boolean denoting if the range is exclusivelength
- iffrom
orto
is negative, and this option is provided, the negative number means backwards indexing and is relative tolength
range
- the range object in natural order containing these properties:from
- the start numberto
- the end numberreversed
- a boolean denoting if the original range is in reversed order