RegExp.escape()
RegExp.escape() は静的メソッドで、文字列内の潜在的な正規表現構文文字をエスケープし、リテラルパターンとして RegExp() コンストラクターで安全に使用できる新しい文字列を返します。
ユーザーが提供したコンテンツを含む RegExp を動的に作成する場合は、この関数を使用して入力を無害化することを検討してください（入力が実際に正規表現構文を含むように意図されている場合を除く）。また、例えば、 String.prototype.replaceAll() を使用して、すべての構文文字の前に \ を挿入するなどして、その機能を再実装しようとしないでください。 RegExp.escape() は、手作業で作成したコードではおそらく達成できないであろう、複数のエッジケース/コンテキストで動作するエスケープシーケンスを使用するように設計されています。
対応ブラウザ
| 機能 | デスクトップ | モバイル | ||||
|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Safari | Chrome Android | Safari iOS | |
| 136 | 136 | 134 | 18.2 | 136 | 18.2 | |
基本構文
JAVASCRIPT
const userInput = 'price: $10.00 (USD)';
const escaped = RegExp.escape(userInput);
// 'price\\: \\$10\\.00 \\(USD\\)'
const regex = new RegExp(escaped);
regex.test('price: $10.00 (USD)'); // trueライブデモ
実務での使いどころ
-
RegExp.escape() の活用
RegExp.escape() は静的メソッドで、文字列内の潜在的な正規表現構文文字をエスケープし、リテラルパターンとして RegExp() コンストラクターで安全に使用できる新しい文字列を返します。
注意点
- 古いブラウザ（IE等）では対応していない。対象ブラウザを確認すること。
アクセシビリティ
- JavaScript による動的更新時は、aria-live リージョンで変更をスクリーンリーダーに通知する。