summaryrefslogtreecommitdiff
path: root/node_modules/escape-string-regexp/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/escape-string-regexp/index.d.ts')
-rw-r--r--node_modules/escape-string-regexp/index.d.ts16
1 files changed, 16 insertions, 0 deletions
diff --git a/node_modules/escape-string-regexp/index.d.ts b/node_modules/escape-string-regexp/index.d.ts
new file mode 100644
index 0000000..e8f9288
--- /dev/null
+++ b/node_modules/escape-string-regexp/index.d.ts
@@ -0,0 +1,16 @@
+/**
+Escape RegExp special characters.
+
+You can also use this to escape a string that is inserted into the middle of a regex, for example, into a character class.
+
+@example
+```
+import escapeStringRegexp from 'escape-string-regexp';
+
+const escapedString = escapeStringRegexp('How much $ for a 🦄?');
+//=> 'How much \\$ for a 🦄\\?'
+
+new RegExp(escapedString);
+```
+*/
+export default function escapeStringRegexp(string: string): string;