From 2c4ae43e688a9873e86211ea0e7aeb9ba770dd77 Mon Sep 17 00:00:00 2001 From: Minteck Date: Tue, 18 Oct 2022 08:59:09 +0200 Subject: Update --- alarm/node_modules/ranges-push/README.md | 78 ++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 alarm/node_modules/ranges-push/README.md (limited to 'alarm/node_modules/ranges-push/README.md') diff --git a/alarm/node_modules/ranges-push/README.md b/alarm/node_modules/ranges-push/README.md new file mode 100644 index 0000000..e8c3a47 --- /dev/null +++ b/alarm/node_modules/ranges-push/README.md @@ -0,0 +1,78 @@ +# ranges-push + +> Gather string index ranges + +
+ + page on npm + + + page on codsen.com + + + page on github + + + Downloads per month + + + Code style: prettier + + MIT License + + libera manifesto + +
+ +## Install + +```bash +npm i ranges-push +``` + +## Quick Take + +```js +import { strict as assert } from "assert"; +import { Ranges } from "ranges-push"; +import { rApply } from "ranges-apply"; + +const gatheredRanges = new Ranges(); + +const oldString = `The quick brown fox jumps over the lazy dog.`; + +// push the ranges +gatheredRanges.push(35, 43, "little Red Riding Hood"); +gatheredRanges.push(4, 19, "bad grey wolf"); + +// retrieve the merged and sorted ranges by calling .current() +assert.deepEqual(gatheredRanges.current(), [ + [4, 19, "bad grey wolf"], + [35, 43, "little Red Riding Hood"], +]); + +assert.equal( + rApply(oldString, gatheredRanges.current()), + "The bad grey wolf jumps over the little Red Riding Hood." +); + +// wipe all gathered ranges +gatheredRanges.wipe(); +assert.equal(gatheredRanges.current(), null); +``` + +## Documentation + +Please [visit codsen.com](https://codsen.com/os/ranges-push/) for a full description of the API and examples. + +## Contributing + +To report bugs or request features or assistance, [raise an issue](https://github.com/codsen/codsen/issues/new/choose) on GitHub. + +## Licence + +MIT License + +Copyright (c) 2010-2021 Roy Revelt and other contributors + +ok codsen star -- cgit