escape-string-regexp

What is escape-string-regexp?

The escape-string-regexp package is used to escape any characters that have special meaning in regular expressions. It takes a string and escapes characters that could be interpreted in a regex pattern, allowing the string to be used within a regex without triggering its special behavior.

What are escape-string-regexp's main functionalities?

Escaping special characters in strings for use in regular expressions

This feature is useful when you want to create a regular expression that includes literal strings that may contain characters that would normally be interpreted as special regex tokens. By escaping these characters, they are treated as literals in the regex pattern.

const escapeStringRegexp = require('escape-string-regexp');
const escapedString = escapeStringRegexp('Hello. How are you?');
// escapedString would be 'Hello\. How are you\?'

Other packages similar to escape-string-regexp

regexp-quote

This package provides similar functionality to escape-string-regexp by escaping special characters in strings for use in regular expressions. It is an alternative that can be used for the same purpose.

regex-escape

Another package that serves the same purpose as escape-string-regexp, regex-escape allows you to escape special characters in strings to safely use them in regular expressions.

README

escape-string-regexp

Escape RegExp special characters

Install

$ npm install escape-string-regexp

Usage

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.

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}