Package Exports
- ranges-sort
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 (ranges-sort) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
ranges-sort
Sort natural number index ranges [ [5, 6], [1, 3] ] => [ [1, 3], [5, 6] ]
Install
npm i ranges-sort// consume as CommonJS require:
const rangesSort = require('ranges-sort')
// or as a native ES module:
import rangesSort from 'ranges-sort'Here's what you'll get:
| Type | Key in package.json |
Path | Size |
|---|---|---|---|
Main export - CommonJS version, transpiled to ES5, contains require and module.exports |
main |
dist/ranges-sort.cjs.js |
3 KB |
ES module build that Webpack/Rollup understands. Untranspiled ES6 code with import/export. |
module |
dist/ranges-sort.esm.js |
3 KB |
UMD build for browsers, transpiled, minified, containing iife's and has all dependencies baked-in |
browser |
dist/ranges-sort.umd.js |
15 KB |
Table of Contents
Rationale
It sorts the array of index arrays, for example:
[ [5, 6], [1, 3] ] => [ [1, 3], [5, 6] ]
[ [5, 6], [5, 3], [5, 0] ] => [ [5, 0], [5, 3], [5, 6] ]
[] => []
[[1, 2], []] => // throws, because there's at least one empty range
[['a']] => // throws, because range is not a range but a string
[[1], [2]] => // throws, because one index is not a range
// 3rd argument and onwards are ignored:
[[3, 4, 'aaa', 'bbb'], [1, 2, 'zzz']] => [[1, 2, 'zzz'], [3, 4, 'aaa', 'bbb']]API
rangesSort(arr[, opts])
| Input argument | Type | Obligatory? | Description |
|---|---|---|---|
arrOfRanges |
Plain object | yes | Array of zero or more arrays meaning natural number ranges (2 elements each) |
opts |
Plain object | no | Optional options go here. |
For example,
[ [5, 9], [5, 3] ] => [ [5, 3], [5, 9] ]This package does not mutate the input array.
Options object
options object's key |
Type | Obligatory? | Default | Description |
|---|---|---|---|---|
| { | ||||
strictlyTwoElementsInRangeArrays |
Boolean | no | false |
If set to true, all ranges must have two and only elements, otherwise error is thrown. For example, input being [ [1, 2, 'zzz'] ] would throw (3 elements), as well as [ ['a'] ] (1 element). |
| } |
Output: Sorted input array. First, we sort by the first argument of each child range array, then by second.
Contributing
If you want a new feature in this package or you would like us to change some of its functionality, raise an issue on this repo.
If you tried to use this library but it misbehaves, or you need an advice setting it up, and its readme doesn't make sense, just document it and raise an issue on this repo.
If you would like to add or change some features, just fork it, hack away, and file a pull request. We'll do our best to merge it quickly. Code style is
airbnb-base, only without semicolons. If you use a good code editor, it will pick up the established ESLint setup.
Licence
MIT License (MIT)
Copyright © 2018 Codsen Ltd, Roy Revelt