【Node.js24.x】Array::toLocaleString()メソッドの使い方
toLocaleStringメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
toLocaleStringメソッドは、配列の各要素を地域設定(ロケール)に応じた文字列に変換し、それらを結合して一つの文字列として返すメソッドです。このメソッドは、配列内に格納された日付、数値、通貨などのデータを、ユーザーが認識しやすい文化圏ごとの適切な書式で表示するために利用されます。
具体的には、配列の各要素に対して、その要素が持つtoLocaleStringメソッド(例えばDateオブジェクトやNumberオブジェクトのtoLocaleString)を内部的に呼び出し、地域ごとの適切な文字列表現を取得します。そして、取得した各要素の文字列をコンマで区切って結合し、最終的な一つの文字列を生成します。配列内のnullやundefinedの要素は、内部的に空文字列として扱われます。
このメソッドは、localesとoptionsという二つのオプション引数を受け取ります。locales引数には、使用する言語と地域を示す文字列、例えば「ja-JP」(日本語-日本)や「en-US」(英語-アメリカ)を指定することで、明示的に特定の地域の書式を適用できます。options引数には、日付や数値の書式設定に関するさらに詳細なオプションをオブジェクト形式で指定することが可能です。これらの引数を省略した場合、Node.jsが動作している環境のデフォルトのロケールが自動的に使用されます。
この機能により、国際化対応が必要なアプリケーションにおいて、配列に格納されたデータを柔軟かつ正確に各地域のユーザー向けに表示することができます。
構文(syntax)
const items = [12345.67, new Date()];
const formattedItems = items.toLocaleString('en-US', { style: 'currency', currency: 'USD', year: 'numeric', month: 'long', day: 'numeric' });
console.log(formattedItems);
引数(parameters)
locales, options
- locales: string | string[] | undefined: 変換に使用するロケールを指定します。指定しない場合は、実行環境のデフォルトロケールが使用されます。
- options: Intl.DateTimeFormatOptions | Intl.NumberFormatOptions | undefined: 数値のフォーマット方法を詳細に指定するオプションオブジェクトです。
戻り値(return)
String
Array.prototype.toLocaleString()は、配列の各要素を文字列に変換し、それらを連結した文字列を返します。この変換は、実行環境のロケール(地域設定)に基づいた書式で行われます。