Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【JavaScript ECMAScript】BigInt::BigInt.prototype.toLocaleStringインスタンスメソッドの使い方

BigInt.prototype.toLocaleString()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

BigInt.prototype.toLocaleString()メソッドは、BigInt値を言語や地域に特化した形式の文字列に変換して表示するメソッドです。JavaScriptのBigIntは、通常のNumber型では扱えない大きな整数値を扱う際に利用されます。このメソッドは、BigInt値を読みやすいよう、地域ごとの桁区切りなどの書式に自動整形します。

引数として、変換するロケールを示す文字列(例: 'en-US'や'ja-JP')や、通貨などの表示スタイルを調整するオプションオブジェクトを受け取ります。ロケールを指定しない場合、実行環境のデフォルト設定が適用されます。BigIntは整数値のため、小数点の書式設定は適用されません。

例えば、「12345678901234567890n」のようなBigInt値も、このメソッドを使えば、アメリカ英語のロケールでは「12,345,678,901,234,567,890」、ドイツ語のロケールでは「12.345.678.901.234.567.890」のように、それぞれの地域の慣習に合わせた読みやすい形式の文字列として得られます。これにより、大規模な数値をユーザーインターフェースで表示する際などに、利用者の理解を深めるのに役立ちます。

公式リファレンス: BigInt.prototype.toLocaleString()

構文(syntax)

1const bigIntValue = 12345678901234567890n;
2bigIntValue.toLocaleString();

引数(parameters)

locales = undefined, options = undefined

  • locales: string | string[] | undefined: ロケールを指定する文字列または文字列の配列。指定しない場合は、実行環境のデフォルトロケールが使用される。
  • options: Intl.NumberFormatOptions | undefined: 書式設定のオプションを指定するオブジェクト。

戻り値(return)

string

指定されたBigIntオブジェクトの数値を、ロケール固有の書式設定規則に従って文字列に変換して返します。

関連コンテンツ