【JavaScript ECMAScript】String::String.prototype.replaceAllインスタンスメソッドの使い方
String.prototype.replaceAll()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
String.prototype.replaceAll()メソッドは、文字列内で指定されたパターン(部分文字列または正規表現)のすべての出現箇所を、別の指定された文字列に置換した新しい文字列を返すメソッドです。
このメソッドはStringインスタンスから呼び出されます。第一引数には検索パターン(文字列または正規表現)、第二引数には置換文字列、または置換文字列を生成する関数を指定します。正規表現をパターンとして使う場合、すべての出現箇所を置換するためには、グローバル検索を示すgフラグが必須であり、これが欠けるとエラーとなります。関数を指定すると、マッチした各箇所で実行され、その戻り値が置換されます。
元の文字列は変更されず、常に新しい文字列が返されます。これによりデータが安全に保たれます。特定の文字や単語の一括削除、テンプレートの複数項目の更新など、広範囲な文字列置換に非常に有効です。ECMAScript 2021で標準化され、JavaScriptの文字列操作を効率化します。
公式リファレンス: String.prototype.replaceAll()
構文(syntax)
1const originalString = "Hello world, hello universe."; 2const replacedString = originalString.replaceAll("hello", "hi"); 3console.log(replacedString);
引数(parameters)
pattern, replacement
- pattern: string | RegExp: 置換対象の文字列または正規表現を指定します。
- replacement: string | (substring: string, ...args: any[]) => string: 置換後の文字列、または置換処理を行う関数を指定します。
戻り値(return)
string
指定された文字列内のすべての一致する部分文字列を、指定された置換文字列で置き換えた新しい文字列を返します。