summaryrefslogtreecommitdiff
path: root/school/node_modules/ranges-push/README.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
committerMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
commit99c1d9af689e5325f3cf535c4007b3aeb8325229 (patch)
treee663b3c2ebdbd67c818ac0c5147f0ce1d2463cda /school/node_modules/ranges-push/README.md
parent9871b03912fc28ad38b4037ebf26a78aa937baba (diff)
downloadpluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.gz
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.bz2
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.zip
Update - This is an automated commit
Diffstat (limited to 'school/node_modules/ranges-push/README.md')
-rw-r--r--school/node_modules/ranges-push/README.md78
1 files changed, 78 insertions, 0 deletions
diff --git a/school/node_modules/ranges-push/README.md b/school/node_modules/ranges-push/README.md
new file mode 100644
index 0000000..e8c3a47
--- /dev/null
+++ b/school/node_modules/ranges-push/README.md
@@ -0,0 +1,78 @@
+# ranges-push
+
+> Gather string index ranges
+
+<div class="package-badges">
+ <a href="https://www.npmjs.com/package/ranges-push" rel="nofollow noreferrer noopener">
+ <img src="https://img.shields.io/badge/-npm-blue?style=flat-square" alt="page on npm">
+ </a>
+ <a href="https://codsen.com/os/ranges-push" rel="nofollow noreferrer noopener">
+ <img src="https://img.shields.io/badge/-codsen-blue?style=flat-square" alt="page on codsen.com">
+ </a>
+ <a href="https://github.com/codsen/codsen/tree/main/packages/ranges-push" rel="nofollow noreferrer noopener">
+ <img src="https://img.shields.io/badge/-github-blue?style=flat-square" alt="page on github">
+ </a>
+ <a href="https://npmcharts.com/compare/ranges-push?interval=30" rel="nofollow noreferrer noopener" target="_blank">
+ <img src="https://img.shields.io/npm/dm/ranges-push.svg?style=flat-square" alt="Downloads per month">
+ </a>
+ <a href="https://prettier.io" rel="nofollow noreferrer noopener" target="_blank">
+ <img src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg?style=flat-square" alt="Code style: prettier">
+ </a>
+ <img src="https://img.shields.io/badge/licence-MIT-brightgreen.svg?style=flat-square" alt="MIT License">
+ <a href="https://liberamanifesto.com" rel="nofollow noreferrer noopener" target="_blank">
+ <img src="https://img.shields.io/badge/libera-manifesto-lightgrey.svg?style=flat-square" alt="libera manifesto">
+ </a>
+</div>
+
+## 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
+
+<img src="https://codsen.com/images/png-codsen-ok.png" width="98" alt="ok" align="center"> <img src="https://codsen.com/images/png-codsen-1.png" width="148" alt="codsen" align="center"> <img src="https://codsen.com/images/png-codsen-star-small.png" width="32" alt="star" align="center">