ranges-apply^5.1.0

Quick Take

import { strict as assert } from "assert";
import { rApply } from "ranges-apply";

const oldString = `The quick brown fox jumps over the lazy dog.`;
const ranges = [
  [4, 19, "bad grey wolf"],
  [35, 43, "little Red Riding Hood"],
];
assert.equal(
  rApply(oldString, ranges),
  "The bad grey wolf jumps over the little Red Riding Hood."
);

Purpose

It takes the source string and the amendments described by Ranges and produces a new string.

API

rApply(
inputString,
rangesArray,
[progressFn]
)

API - Output

Function returns an amended string.

The algorithm

We array.reduce() your given ranges array, slicing the input string accordingly. If given ranges is not array but null (meaning absence of ranges), same string is returned.

In our case

Originally this library was part of email-comb, where we traversed HTML as a string and compiled an array of things to delete or replace later, in one go. The performance was important, so it was not a good idea to delete/replace things on the spot because each deletion slowed down the process. Instead, we traversed the string, compiled this to-do array, then did the deletion/replacement on the whole thing, once. This appears to be the fastest way.

We're going to use this library in all our HTML processing libraries who work on HTML as on string, without parsing it.

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