https://github.com/sindresorhus/escape-string-regexp

Escape RegExp special characters
https://github.com/sindresorhus/escape-string-regexp

Last synced: about 1 month ago
JSON representation

Escape RegExp special characters

• Host: GitHub
• URL: https://github.com/sindresorhus/escape-string-regexp
• Owner: sindresorhus
• License: mit
• Created: 2014-06-24T15:04:40.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2022-06-04T02:44:23.000Z (over 2 years ago)
• Last Synced: 2024-04-13T21:01:01.063Z (7 months ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 570
• Watchers: 13
• Forks: 55
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-nodejs-cn - escape-string-regexp - 转义RegExp特殊字符. (包 / 文本)
• awesome-nodejs - escape-string-regexp - Escape RegExp special characters.  (Repository / RegExp/Glob)
• awesome-nodejs-cn - escape-string-regexp - **star:571** 转义RegExp特殊字符 (包 / 文本)
• awesome-nodejs - escape-string-regexp - Escape RegExp special characters. (Packages / Text)
• awesome-nodejs - escape-string-regexp - Escape RegExp special characters - ★ 270 (Text)
• awesome-node - escape-string-regexp - Escape RegExp special characters. (Packages / Text)
• awesome-nodejs-cn - escape-string-regexp - 转义RegExp特殊字符. (目录 / 文本处理)

README

        
# escape-string-regexp

> Escape RegExp special characters

## Install

```sh

npm install escape-string-regexp

```

## Usage

```js

import escapeStringRegexp from 'escape-string-regexp';

const escapedString = escapeStringRegexp('How much $ for a 🦄?');

//=> 'How much \\$ for a 🦄\\?'

new RegExp(escapedString);

```

You can also use this to escape a string that is inserted into the middle of a regex, for example, into a character class.

Only the minimal amount of escaping is done, and developers are expected to insert escaped strings at safe positions in a `RegExp`. This keeps the output simple and gives you the best results in most cases. For edge case placements of escaped strings (such as immediately following `\0` or `\c`), the escaped value can change the meaning of the preceding or following token. If fully context-aware escaping is needed, consider interpolating a string using the [`regex`](https://github.com/slevithan/regex#interpolating-escaped-strings) package.