summaryrefslogtreecommitdiff
path: root/alarm/node_modules/string-strip-html/README.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-10-18 08:59:09 +0200
committerMinteck <contact@minteck.org>2022-10-18 08:59:09 +0200
commit2c4ae43e688a9873e86211ea0e7aeb9ba770dd77 (patch)
tree17848d95522dab25d3cdeb9c4a6450e2a234861f /alarm/node_modules/string-strip-html/README.md
parent108525534c28013cfe1897c30e4565f9893f3766 (diff)
downloadpluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.tar.gz
pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.tar.bz2
pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.zip
Update
Diffstat (limited to 'alarm/node_modules/string-strip-html/README.md')
-rw-r--r--alarm/node_modules/string-strip-html/README.md78
1 files changed, 78 insertions, 0 deletions
diff --git a/alarm/node_modules/string-strip-html/README.md b/alarm/node_modules/string-strip-html/README.md
new file mode 100644
index 0000000..7721e66
--- /dev/null
+++ b/alarm/node_modules/string-strip-html/README.md
@@ -0,0 +1,78 @@
+# string-strip-html
+
+> Strips HTML tags from strings. No parser, accepts mixed sources.
+
+<div class="package-badges">
+ <a href="https://www.npmjs.com/package/string-strip-html" 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/string-strip-html" 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/string-strip-html" 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/string-strip-html?interval=30" rel="nofollow noreferrer noopener" target="_blank">
+ <img src="https://img.shields.io/npm/dm/string-strip-html.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 string-strip-html
+```
+
+## Quick Take
+
+```js
+import { strict as assert } from "assert";
+import { stripHtml } from "string-strip-html";
+
+assert.equal(
+ stripHtml(`Some text <b>and</b> text.`).result,
+ `Some text and text.`
+);
+
+// prevents accidental string concatenation
+assert.equal(stripHtml(`aaa<div>bbb</div>ccc`).result, `aaa bbb ccc`);
+
+// tag pairs with content, upon request
+assert.equal(
+ stripHtml(`a <pre><code>void a;</code></pre> b`, {
+ stripTogetherWithTheirContents: [
+ "script", // default
+ "style", // default
+ "xml", // default
+ "pre", // <-- custom-added
+ ],
+ }).result,
+ `a b`
+);
+
+// detects raw, legit brackets:
+assert.equal(stripHtml(`a < b and c > d`).result, `a < b and c > d`);
+```
+
+## Documentation
+
+Please [visit codsen.com](https://codsen.com/os/string-strip-html/) 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">