All files / string escape-reg-exp.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
83x
 
 
const SYNTAX_CHARACTERS: ReadonlySet<string> = new Set([
  '\\',
  '^',
  '$',
  '.',
  '*',
  '+',
  '?',
  '(',
  ')',
  '[',
  ']',
  '{',
  '}',
  '|',
  '/',
]);
 
/**
 * Escapes a text so that it matches literally in a regular expression, `v` flag included.
 *
 * @param input - The literal text to search for.
 * @returns The text with every regular expression syntax character escaped.
 * @example
 * new RegExp(`^${escapeRegExp('1+1=2?')}$`, 'v').test('1+1=2?'); // true
 */
export function escapeRegExp(input: string): string {
  return Array.from(input, (character) => (SYNTAX_CHARACTERS.has(character) ? `\\${character}` : character)).join('');
}