【JavaScript ECMAScript】Array::Array.prototype.toLocaleStringインスタンスメソッドの使い方
Array.prototype.toLocaleString()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Array.prototype.toLocaleString()メソッドは、配列のすべての要素を文字列に変換し、地域に適した形式で連結した新しい文字列を生成して返すメソッドです。このメソッドは、配列の各要素に対して、その要素自身のtoLocaleString()メソッド(例えば、DateオブジェクトのtoLocaleString()やNumberオブジェクトのtoLocaleString()など)を呼び出し、得られた文字列を適切な区切り文字で結合します。
標準的なArray.prototype.toString()メソッドが単に配列要素をカンマで区切るのに対し、toLocaleString()メソッドは、数値の桁区切り記号や日付の表示順序など、言語や地域によって異なる書式設定を考慮して文字列を生成する点が大きな特徴です。これにより、国際化対応が必要なアプリケーションにおいて、ユーザーの地域設定に応じた自然な表示を実現できます。
このメソッドはオプションとして、ロケール(言語と地域の情報、例: 'en-US'、'ja-JP')を指定する引数と、書式設定の詳細をカスタマイズするためのオプションオブジェクトを受け取ります。これらの引数を使用することで、特定の地域文化に合わせた表示や、日付や数値の書式を細かく制御することが可能です。引数を指定しない場合、JavaScriptが実行されている環境のデフォルトロケールが使用されます。戻り値は、地域設定に基づいて書式化された配列の要素を表す単一の文字列です。
構文(syntax)
1const arr = [12345.678, new Date('2023-10-27T10:00:00Z')]; 2const localizedString = arr.toLocaleString('en-US', { 3 style: 'decimal', 4 minimumFractionDigits: 2, 5 year: 'numeric', 6 month: 'short', 7 day: 'numeric' 8});
引数(parameters)
locales, options
- locales: string | string[] | undefined: ロケール(言語や地域)を指定します。指定しない場合、実行環境のデフォルトロケールが使用されます。
- options: Intl.NumberFormatOptions | Intl.DateTimeFormatOptions | undefined: 数値や日付のフォーマット方法を詳細に指定するオブジェクトです。
戻り値(return)
文字列
配列の各要素を、指定されたロケール(言語・地域設定)に応じた文字列形式に変換したものを連結した文字列を返します。