# @lvchengbin/escape

> A simple library for escaping specical characters in strings for HTML, CSS, RegExp, String, URL.

Latest version **0.0.3** (published 2018-07-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lvchengbin/escape
pnpm add @lvchengbin/escape
yarn add @lvchengbin/escape
bun add @lvchengbin/escape
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2018-07-07 |
| First published | 2018-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | LvChengbin |
| Maintainers | lvchengbin |
| Keywords | escape, encode, encodeHTML, encodeURL, html, string, css, url, regexp, regex |

## Links

- npm: https://www.npmjs.com/package/@lvchengbin/escape
- Repository: https://github.com/LvChengbin/escape
- Homepage: https://github.com/LvChengbin/escape#readme
- Issues: https://github.com/LvChengbin/escape/issues
- npm.io page: https://npm.io/package/@lvchengbin/escape

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2018-07-07
- 0.0.2 — 2018-01-23
- 0.0.1 — 2018-01-20

## README

# escape

A simple library for escaping specical characters in strings for HTML, CSS, RegExp, String, URL.

## Start

Installing the package with `npm`.

```js
$ npm i @lvchengbin/escape --save
```

To use the package in nodejs code.

```js
const escape = require( '@lvchengbin/escape' );
```

If you want to use the package as a ES6 module, you can import it like this:

```js
import escape from '@lvchengbin/escape';
```

Sometimes, maybe you don't want to pack all the code in the library into your project with some bundle toolkits such as rollup, you can import the function that you want to import separately.

```js
import escapeHTML from '@lvchengbin/escape/src/html';
import escapeCSS from '@lvchengbin/escape/src/css';
import escapeRegExp from '@lvchengbin/escape/src/regexp';
import escapeString from '@lvchengbin/escape/src/string';
import escapeURL from '@lvchengbin/escape/src/url';
```

We also provide files for using in browsers with `<script>` tag, you can get it here [escape.js](https://raw.githubusercontent.com/LvChengbin/escape/master/dist/escape.js), and if you want to use it in browsers not supporting ES5 syntax, please use [escape.bc.js](https://raw.githubusercontent.com/LvChengbin/escape/master/dist/escape.bc.js).

```html
<script src="https://raw.githubusercontent.com/LvChengbin/escape/master/dist/escape.js"></script>
```

```html
<script src="https://raw.githubusercontent.com/LvChengbin/escape/master/dist/escape.bc.js"></script>
```

## Usage

```js
import escape from '@lvchengbin/escape';

// escape html special chars
escape.html( '<p>content</p>' );

// escape css special chars
// https://drafts.csswg.org/cssom/#common-serializing-idioms
escape.css( '@#.abc' );

// escape regex special chars
//https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
escape.regexp( '[abc]' );

// escape special chars in string
escape.string( '"\n\r\'' );

// escape URL
escape.url( 'http://xxx.xxx' );
```

---
_Source: https://npm.io/package/@lvchengbin/escape · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._