ranges-crop^3.0.2

Crop array of ranges when they go beyond the reference string's length

Install via npm

npm i ranges-crop

The default is exported, so instead of crop below, you can name the consumed function however you want.

Consume via a require():

const crop = require("ranges-crop");

or as an ES Module:

import crop from "ranges-crop";

Install as a script, via CDN

Put this in your HTML:

<script src="https://cdn.jsdelivr.net/npm/ranges-crop/dist/ranges-crop.umd.js">

Then, you’ll get a global variable rangesCrop in your Global object and you consume it like this:

const crop = rangesCrop;

This crop is your main function. See its API in the main section.

Learn more about Ranges

We have a dedicated page about Ranges. Learn more

Trivia

This program has 64 assertions in its unit tests. That's more than all unit test assertions' median (50) but less than geometric mean (70).

In monorepo, 2 other packages consume this package.

§ Quick Take

import { strict as assert } from "assert";
import crop from "ranges-crop";

assert.deepEqual(
  crop(
    [
      [2, 3],
      [9, 10, "bad grey wolf"],
      [1, 2],
    ],
    7
  ),
  [[1, 3]] // sorted, merged and cropped
);

⬆ back to top

§ Purpose

It crops the ranges, ensuring no range from an array goes beyond a given index.

Along the way, it will also merge and sort ranges.

⬆ back to top

§ API

crop(arr, strLen)

Input argument	Type	Obligatory?	Description
`arrOfRanges`	`null` or ranges - array of zero or more arrays	yes	Provide an array of ranges to invert. Ranges do not have to be sorted or merged.
`strLen`	Natural number or zero	yes	Algorithm needs to know the length of the reference string to calculate the inverted last slice's ending index.