Skip to content

Commit

Permalink
Clarify that minimal escaping is done and describe edge cases (#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
slevithan committed Jun 14, 2024
1 parent ba9a447 commit 6fe67c0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ new RegExp(escapedString);

You can also use this to escape a string that is inserted into the middle of a regex, for example, into a character class.

Only the minimal amount of escaping is done, and developers are expected to insert escaped strings at safe positions in a `RegExp`. This keeps the output simple and gives you the best results in most cases. For edge case placements of escaped strings (such as immediately following `\0` or `\c`), the escaped value can change the meaning of the preceding or following token. If fully context-aware escaping is needed, consider interpolating a string using the [`regex`](https://github.com/slevithan/regex#interpolating-escaped-strings) package.

---

<div align="center">
Expand Down

0 comments on commit 6fe67c0

Please sign in to comment.