aboutsummaryrefslogtreecommitdiff
path: root/node_modules/escape-string-regexp/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/escape-string-regexp/readme.md')
-rw-r--r--node_modules/escape-string-regexp/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/escape-string-regexp/readme.md b/node_modules/escape-string-regexp/readme.md
new file mode 100644
index 0000000..157472b
--- /dev/null
+++ b/node_modules/escape-string-regexp/readme.md
@@ -0,0 +1,29 @@
+# escape-string-regexp [![Build Status](https://travis-ci.org/sindresorhus/escape-string-regexp.svg?branch=master)](https://travis-ci.org/sindresorhus/escape-string-regexp)
+
+> Escape RegExp special characters
+
+
+## Install
+
+```
+$ npm install escape-string-regexp
+```
+
+
+## Usage
+
+```js
+const escapeStringRegexp = require('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.
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)