https://github.com/cloud-automation/js-range-list

A simple javascript tool for merging intervals.
https://github.com/cloud-automation/js-range-list

Last synced: 27 days ago
JSON representation

A simple javascript tool for merging intervals.

• Host: GitHub
• URL: https://github.com/cloud-automation/js-range-list
• Owner: Cloud-Automation
• Created: 2016-03-28T18:21:23.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-03-28T18:24:58.000Z (over 8 years ago)
• Last Synced: 2024-10-11T01:54:41.998Z (about 1 month ago)
• Language: JavaScript
• Size: 2.93 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Range List

Simple and easy tool to merge intervals.

## Installation

A simple `npm install --save js-range-list` will do the trick.

## Example

    var RangeList = require('js-range-list')();

    // add a new interval from [0:2] to the list

    RangeList.merge(0, 2);

    // [ { start: 0, end: 2 }]

    RangeList.merge(4, 10};

    

    // [ { start: 0, end: 2 }, { start : 4, end: 10 }]

    RangeList.merge(2, 6);

    // [ { start: 0, end: 10 }]

    RangeList.getList();

## API

### RangeList([max])

Returns a new RangeList with an optional parameter `max` for the maxmial size of a single interval.

### .merge(start, end)

Adds a new interval to the list. The new interval gets autmatically merged into the existing intervals.

### .getList()

Returns the list of intervals.

## Testing

You can test the module with `jasmine` or `npm test`.

## LICENSE

The MIT License (MIT)

Copyright (c) 2016 [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.