【JavaScript ECMAScript】Temporal::Temporal.Instant.prototype.toLocaleStringインスタンスメソッドの使い方
Temporal.Instant.prototype.toLocaleString()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.Instant.prototype.toLocaleString()メソッドは、Temporal.Instantオブジェクトが保持する特定時点の時刻情報を、ユーザーの地域や言語の設定(ロケール)に基づいた、人間にとって読みやすい形式の文字列に変換して返します。Temporal.Instantオブジェクトは、日付や時刻を世界協定時(UTC)で厳密に表す不変なデータ型です。しかし、この生のタイムスタンプ情報だけでは、日付の順序、時刻のフォーマット、使用される文字などが地域によって異なり、そのまま表示するとユーザーにとって分かりにくい場合があります。
このメソッドは、引数としてロケールを示す文字列や、日付や時刻の表示方法を細かく指定するオプションオブジェクトを受け取ることができます。例えば、年を4桁で表示するか2桁で表示するか、月を数字で表示するか名前で表示するか、または時間帯を含めるか否かといった表示形式の設定が可能です。これらの引数を省略した場合、メソッドは実行されているJavaScript環境のデフォルトのロケール設定と標準的な書式を使用して文字列を生成します。これにより、アプリケーションが世界中のユーザーに対して適切に日時を表示するための、国際化対応に不可欠な機能を提供し、開発者は地域ごとの慣習に合わせた日時表示を容易に実現できます。
構文(syntax)
1const instant = Temporal.Instant.from('2023-10-27T10:00:00Z'); 2instant.toLocaleString(locales, options);
引数(parameters)
locales, options
- locales: string | string[] | undefined: 表示形式に使用するロケール(言語・地域)を指定します。指定しない場合は、実行環境のデフォルトロケールが使用されます。
- options: Intl.DateTimeFormatOptions | undefined: 表示形式を細かく制御するためのオプションを指定します。
戻り値(return)
String
現在時刻を表す Temporal.Instant オブジェクトを、実行環境のロケール(地域と言語の設定)に基づいて、人間が読みやすい文字列形式に変換したものを返します。