escapeRegExp (Lodash compatibility)

::: warning Use escapeRegExp from es-toolkit

This escapeRegExp function operates slower due to handling non-string input values.

Instead, use the faster and more modern escapeRegExp from es-toolkit.

:::

Escapes regular expression special characters in a string.

const result = escapeRegExp(str);

Usage

escapeRegExp(str)

Escapes regular expression special characters ^, $, \, ., *, +, ?, (, ), [, ], {, }, | in a string. This is useful when you want to treat a string literally when dynamically creating regular expressions.

import { escapeRegExp } from 'es-toolkit/compat';

escapeRegExp('[es-toolkit](https://es-toolkit.dev/)');
// '\\[es-toolkit\\]\\(https://es-toolkit\\.dev/\\)'

escapeRegExp('$^{}.+*?()[]|\\');
// '\\$\\^\\{\\}\\.\\+\\*\\?\\(\\)\\[\\]\\|\\\\'

Non-string values are also converted to strings before processing.

import { escapeRegExp } from 'es-toolkit/compat';

escapeRegExp(123); // '123'
escapeRegExp(null); // ''
escapeRegExp(undefined); // ''

Parameters

• str (string, optional): The string to escape regular expression special characters.

Returns

(string): Returns the string with regular expression special characters escaped.