ranges-sort open source npm package

No 3rd party dependencies. All dependencies and devDependencies, checked recursively, are Codsen packages.

Permalink to InstallationInstallation

Choose the installation type:

The main function rSort() is imported like this:

It’s a function which takes two input arguments:

Input argument	Type	Obligatory	Description
	`arrOfRanges` Type: Array or `null` Obligatory: yes
`arrOfRanges`	Array or `null`	yes	Input ranges.

	`opts` Type: Plain object Obligatory: no
`opts`	Plain object	no	Optional Options Object.

None of the input arguments will be mutated by this program, we have unit tests to prove that.

The Optional Options Object has the following shape:

Key	Type	Obligatory	Default	Description
	`strictlyTwoElementsInRangeArrays` Type: Boolean Obligatory: no Default: `false`
`strictlyTwoElementsInRangeArrays`	Boolean	no	`false`	When `true`, every range must contain exactly two elements. For example, `[[1, 2, "zzz"]]` and `[["a"]]` throw because their ranges contain three and one elements, respectively.

	`progressFn` Type: Function, `false`, `null`, or `undefined` Obligatory: no Default: `null`
`progressFn`	Function, `false`, `null`, or `undefined`	no	`null`	Receives best-effort integer progress from 0 to 100. A successful nonempty sort ends at 100 without duplicate values. Empty inputs and validation failures do not call it. Use `false` or `null` to disable it.

Here are all defaults in one place for copying:

The function will return sorted ranges array (or null if that was passed).

You can import defaults:

It's a plain object:

The main function calculates the options to be used by merging the options you passed with these defaults.

You can import version:

This package is written in TypeScript and exports the following types:

Type	Description
	`Opts` Type: `Opts`
`Opts`	The Optional Options Object of `rSort()`, documented above.

	`ProgressFn` Type: `ProgressFn`
`ProgressFn`	The signature of `opts.progressFn` — called with the percentage done.

	`Range` Type: `Range`
`Range`	A single range: a two- or three-element array.

	`Ranges` Type: `Ranges`
`Ranges`	Zero or more `Range`s, or `null`.

import type { Opts, ProgressFn, Range, Ranges } from "ranges-sort";