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 31 32 33 34 35 36 37 38 39 40 |
x1 x1 x1 x1 x1 x1 x1 |
/**
* Functions for tasks related to
* {@link https://en.wikipedia.org/wiki/Regular_expression | regular expression} (regexp),
* such as escaping text for interpolation into a regexp.
*
* ```ts
* import { escape } from "@std/regexp/escape";
* import { assertEquals, assertMatch, assertNotMatch } from "@std/assert";
*
* const re = new RegExp(`^${escape(".")}$`, "u");
*
* assertEquals("^\\.$", re.source);
* assertMatch(".", re);
* assertNotMatch("a", re);
* ```
*
* @module
*/
import { escape as _function_escape } from "jsr:@std/[email protected]"
/**
* Escapes arbitrary text for interpolation into a regexp, such that it will
* match exactly that text and nothing else.
*
* @example Usage
* ```ts
* import { escape } from "@std/regexp/escape";
* import { assertEquals, assertMatch, assertNotMatch } from "@std/assert";
*
* const re = new RegExp(`^${escape(".")}$`, "u");
*
* assertEquals("^\\.$", re.source);
* assertMatch(".", re);
* assertNotMatch("a", re);
* ```
*
* @param str The string to escape.
* @return The escaped string.
*/
const escape = _function_escape as typeof _function_escape
export { escape }
|