ranges-offset^3.0.1

Quick Take

import { strict as assert } from "assert";
import { rOffset } from "ranges-offset";

assert.deepEqual(
  rOffset(
    [
      [3, 5],
      [8, 7],
    ],
    10
  ),
  [
    [13, 15],
    [18, 17],
  ]
);

// ranges are empty, nothing happens:
assert.deepEqual(rOffset(null, 10), null);

// if input does not resemble ranges, nothing happens:
assert.deepEqual(rOffset(true, 10), true);

API

rOffset(rangesArr, offset)

Output:

• if not ranges were passed, array of one or more arrays, same input will be returned
• ELSE, offset value will be added to each index of every range

Inputs are not mutated.

Purpose

For example, when working on parsed tokens, we have a value, chunk of string, but we know it starts at index X, not at zero. When we return zero-based result, receiving parties need to increment every index by X. The catch is, empty Ranges are null so Array.prototype.map() can't be used. Hence this library.

Changelog

See it in the monorepo , on GitHub.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub .

Any code contributions welcome! All Pull Requests will be dealt promptly.

Licence

MIT 

Copyright © 2010–2021 Roy Revelt and other contributors