# @fav/text.escape > Escape characters for various syntaxes and formats. Latest version **1.0.5** (published 2019-05-25) · MIT license · 0 weekly downloads ## Install ```sh npm install @fav/text.escape pnpm add @fav/text.escape yarn add @fav/text.escape bun add @fav/text.escape ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.5 | | Published | 2019-05-25 | | First published | 2017-10-22 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 23.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Takayuki Sato | | Maintainers | sttk | | Keywords | escape, characters, regexp, text, fav | ## Links - npm: https://www.npmjs.com/package/@fav/text.escape - Repository: https://github.com/sttk/fav-text.escape - Homepage: https://github.com/sttk/fav-text.escape#readme - Issues: https://github.com/sttk/fav-text.escape/issues - npm.io page: https://npm.io/package/@fav/text.escape ## Alternatives - [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads - [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads - [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads - [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads - [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads ## Recent versions - 1.0.5 (latest) — 2019-05-25 - 1.0.4 — 2019-05-19 - 1.0.3 — 2019-05-12 - 1.0.2 — 2018-04-28 - 1.0.1 — 2018-02-17 - 1.0.0 — 2018-01-05 - 0.1.0 — 2017-10-22 ## README # [@fav/text.escape][repo-url] [![NPM][npm-img]][npm-url] [![MIT License][mit-img]][mit-url] [![Build Status][travis-img]][travis-url] [![Build Status][appveyor-img]][appveyor-url] [![Coverage status][coverage-img]][coverage-url] Escapes characters for various syntaxes and formats. > "fav" is an abbreviation of "favorite" and also the acronym of "for all versions". > This package is intended to support all Node.js versions and many browsers as possible. > At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari. ## Install To install from npm: ```sh $ npm install --save @fav/text.escape ``` ***NOTE:*** *npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from [github.com][repo-url], and move it in `node_modules/@fav/text.escape/` directory manually.* ## Usage For Node.js: ```js var escape = require('@fav/text.escape').RegExp; escape('[@fav/text.escape]'); // => '\\[@fav/text\\.escape\\]' console.log(escape('[@fav/text.escape]')); // => \[@fav/text\.escape\] ``` For Web browsers: ```html ``` ## API ### escape : object Is a set of functins to escape characters in a string. This function set provides escapings for following syntaxes and formats: - [RegExp](#regexp) - [RegExpCharClass](#regexp_charclass) - [HtmlEntity](#html_entity) - [HtmlAttribute](#html_attribute) In addition, the factory functions for two types of escaping are provided: - [byProposition](#by_proposition) - [byReplacement](#by_replacement) **NOTE:** These functions doesn't check data types of the arguments, and assumes that they are given as per the specific data types. #### escape.RegExp(source) : string Escapes special characters of Regular Expression. The special characters which are escaped are as follows: `^$\.*+?()[]{}|`. The specification of the special characters of Regular Expression comes from [ECMA-262 — 21.2 RegExp (Regular Expression) Objects](http://ecma-international.org/ecma-262/7.0/#sec-patterns). ##### Parameter: | Parameter | Type | Description | |-----------|:------:|--------------------------------------------| | source | string | The source string. | ##### Return: | Type | Descriptionn | |:------:|:---------------------| | string | An escaped string. | #### escape.RegExpCharClass(source) : string Escapes special characters of Regular Expression Character Class. The special characters which are escaped are as follows: `-^]\`. ##### Parameter: | Parameter | Type | Description | |-----------|:------:|--------------------------------------------| | source | string | The source string. | ##### Return: | Type | Description | |:------:|:-----------------------| | string | An escaped string. | #### escape.HtmlEntity(source) : string Escapes special characters of HTML entity to character references, etc. The escape mapping for HTML entity is as follows: | source character | replaced text | |:-----------------:|:-------------:| | `'<'` (\u003c) | `'<'` | | `'>'` (\u003e) | `'>'` | | `'&'` (\u0026) | `'&'` | | ~~`' '` (\u0020)~~ | ~~`' '`~~ | | ~~`'\n'` (\u000a)~~ | ~~`'
'`~~ | *NOTE: To reserve multiple spaces(\u0020) and EOL(`\n`), should use CSS's `white-space: pre-wrap`.* ##### Parameter: | Parameter | Type | Description | |-----------|:------:|--------------------------------------------| | source | string | The source string. | ##### Return: | Type | Description | |:------:|:----------------------| | string | An escaped string. | #### escape.HtmlAttribute(source) : string Escapes special characters of HTML attributes to character references. The escape mapping for HTML attribute is as follows: | source character | replaced text | |:-----------------:|:-------------:| | `'<'` (\u003c) | `'<'` | | `'>'` (\u003e) | `'>'` | | `'&'` (\u0026) | `'&'` | | `'"'` (\u0022) | `'"'` | | `"'"` (\u0027) | `'''` | ##### Parameter: | Parameter | Type | Description | |-----------|:------:|--------------------------------------------| | source | string | The source string. | ##### Return: | Type | Description | |:------:|:----------------------| | string | An escaped string. | #### escape.byPreposition(escapingChar [, ...escapedChars]) : function Creates an escape function which escapes special characters by preposition of an espacing character, for example: ```js var escape = fav.text.escape.byPreposition('\\', '"\''); escape('escaping ", \' and \\.'); // => 'escaping \\", \\\' and \\\\.' ``` ##### Parameter: | Parameter | Type | Description | |--------------|:------:|----------------------------------------------------------| | escapingChar | string | The escaping character placed before special characters. This character is escaped, too. | | escapedChars | string | The special characters to be escaped. | ##### Return: | Type | Description | |:--------:|:-----------------------| | function | An escaping function. | #### escape.byReplacement(escapingMap) : function Creates an escape function which escapes special characters by replacement to corresponding strings, for examples: ```js var escape = fav.text.escape.byReplacement({ '"': '"', "'": ''' }); escape('escaping " and \'.'); // => 'escaping " and '.' ``` ##### Parameter: | Parameter | Type | Description | |--------------|:------:|----------------------------------------------------------| | escapingMap | object | The plain object of which keys and values are mappings of escaped characters and replaced strings. | ##### Return: | Type | Description | |:--------:|:----------------------| | function | An escaping function. | ## Checked ### Node.js (4〜12) | Platform | 11 | 12 | |:---------:|:------:|:------:| | macOS |◯|◯| | Windows10 |◯|◯| | Linux |◯|◯| | Platform | 4 | 5 | 6 | 7 | 8 | 9 | 10 | |:---------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|◯|◯| ### io.js (1〜3) | Platform | 1 | 2 | 3 | |:---------:|:------:|:------:|:------:| | macOS |◯|◯|◯| | Windows10 |◯|◯|◯| | Linux |◯|◯|◯| ### Node.js (〜0.12) | Platform | 0.8 | 0.9 | 0.10 | 0.11 | 0.12 | |:---------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯| ### Web browsers | Platform | Chrome | Firefox | Vivaldi | Safari | Edge | IE11 | |:---------:|:------:|:-------:|:-------:|:------:|:------:|:------:| | macOS |◯|◯ |◯ |◯| -- | -- | | Windows10 |◯|◯ |◯ | -- |◯|◯| | Linux |◯|◯ |◯ | -- | -- | -- | ## License Copyright (C) 2017-2019 Takayuki Sato This program is free software under [MIT][mit-url] License. See the file LICENSE in this distribution for more details. [repo-url]: https://github.com/sttk/fav-text.escape/ [npm-img]: https://img.shields.io/badge/npm-v1.0.5-blue.svg [npm-url]: https://www.npmjs.com/package/@fav/text.escape [mit-img]: https://img.shields.io/badge/license-MIT-green.svg [mit-url]: https://opensource.org/licenses/MIT [travis-img]: https://travis-ci.org/sttk/fav-text.escape.svg?branch=master [travis-url]: https://travis-ci.org/sttk/fav-text.escape [appveyor-img]: https://ci.appveyor.com/api/projects/status/github/sttk/fav-text.escape?branch=master&svg=true [appveyor-url]: https://ci.appveyor.com/project/sttk/fav-text-escape [coverage-img]: https://coveralls.io/repos/github/sttk/fav-text.escape/badge.svg?branch=master [coverage-url]: https://coveralls.io/github/sttk/fav-text.escape?branch=master --- _Source: https://npm.io/package/@fav/text.escape · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._