【JavaScript ECMAScript】Number::Number.prototype.toLocaleStringインスタンスメソッドの使い方
Number.prototype.toLocaleString()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
Number.prototype.toLocaleString()メソッドは、数値を言語や地域設定(ロケール)に基づいた書式の文字列に変換して返すメソッドです。このメソッドは、数値データをユーザーにとって最も読みやすい形式で表示し、国や地域によって異なる数値の表記ルール(桁区切り、小数点記号、通貨記号の位置など)に自動で対応します。
メソッドは、書式設定に使用する言語や地域のコードを指定するlocales引数と、数値の具体的な表示形式を細かく制御するためのoptions引数を受け取ります。localesを省略すると、実行環境のデフォルトロケールが適用されます。optionsでは、通貨表示(例: 'currency', 'JPY')、パーセンテージ表示、小数点の桁数、単位表示などを設定可能です。
開発者は、これらの引数を活用することで、金額やパーセンテージといった数値を簡単に各地域の慣習に合わせた適切な書式で表示でき、多言語対応アプリケーションのユーザーエクスペリエンス向上に貢献します。
公式リファレンス: Number.prototype.toLocaleString()
構文(syntax)
1const myNumber = 123456.789; 2const localizedString = myNumber.toLocaleString('en-US', { style: 'currency', currency: 'USD' });
引数(parameters)
locales = undefined, options = undefined
- locales: string | string[] = undefined: 数値の書式設定に使用するロケールを指定します。省略された場合は、実行環境のデフォルトロケールが使用されます。
- options: Intl.NumberFormatOptions = undefined: 数値の書式設定に関する追加のオプションを指定します。
戻り値(return)
string
このメソッドは、現在の数値を、ロケール(言語・地域設定)に応じた書式で表現した文字列を返します。