escapeRegExp

Escapes the 12 ECMAScript regex metacharacters (. * + ? ^ $ { } ( ) | [ ] \) so the string can be safely interpolated into a RegExp. Prevents regex injection when user input is used in a pattern.

Try it

Import

import { escapeRegExp } from "1o1-utils";

import { escapeRegExp } from "1o1-utils/escape-reg-exp";

Signature

function escapeRegExp({ str }: EscapeRegExpParams): string

Parameters

Name	Type	Required	Description
str	string	Yes	The string to escape

Returns

string

Examples

escapeRegExp({ str: "[hello](world)" });
// => "\\[hello\\]\\(world\\)"

const re = new RegExp(escapeRegExp({ str: userInput }), "i");
re.test(text);

Edge Cases

• Throws if str is not a string.
• Returns "" for empty string.
• Strings with no special characters are returned unchanged.
• Unicode characters are preserved.

Also known as

escape regex, regex injection, escape pattern, safe regex

Prompt suggestion

I'm using 1o1-utils (npm: https://www.npmjs.com/package/1o1-utils, GitHub: https://github.com/pedrotroccoli/1o1-utils, LLM context: https://pedrotroccoli.github.io/1o1-utils/llms.txt). Show me how to use escapeRegExp to safely build a RegExp from user input