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

Temporal.PlainDateTime.prototype.toLocaleString()メソッドは、Temporal.PlainDateTimeオブジェクトが保持する日付と時刻の情報を、指定されたロケールと書式設定オプションに従って人間が読みやすい文字列として整形し、その結果を返すメソッドです。このメソッドは、プログラム内で扱われる日付や時刻のデータを、ユーザーにとって理解しやすい形式で表示する際に利用されます。

引数には、主に二つを指定できます。一つ目はlocalesで、日付と時刻の書式に使用する言語や国・地域の情報を指定する文字列または文字列の配列です。これを省略すると、実行環境のデフォルトのロケールが使用されます。二つ目はoptionsで、年、月、日、時、分、秒などの表示スタイルや、それらの要素を数値で表示するか文字で表示するかといった詳細な書式設定を指定するためのオブジェクトです。このoptionsは、JavaScriptの国際化APIであるIntl.DateTimeFormatのオプションと互換性があります。

本メソッドは、Temporal.PlainDateTimeがタイムゾーン情報を含まない日付と時刻を表すオブジェクトであるため、options引数でタイムゾーンに関する設定（例えばtimeZoneNameなど）を指定しても、その設定は結果の文字列に反映されません。戻り値は、指定されたロケールとオプションに基づいて整形された日付と時刻の文字列表現となります。これにより、例えば日本のロケールで「2023年10月26日 15時30分00秒」といった形式の文字列を得ることができます。

Copy
1const plainDateTimeInstance = Temporal.PlainDateTime.from('2023-10-27T10:30:00');
2const formattedDateTime = plainDateTimeInstance.toLocaleString('en-US', { dateStyle: 'full', timeStyle: 'short' });

locales, options

• locales: string | string[] | undefined: フォーマットに使用するロケール（言語と地域）を指定します。省略された場合は、実行環境のデフォルトロケールが使用されます。
• options: Intl.DateTimeFormatOptions | undefined: フォーマットのオプションを指定します。表示する日付や時刻の要素、スタイルなどを細かく制御できます。

string

このメソッドは、Temporal.PlainDateTimeオブジェクトを、実行環境の現在のロケール（言語や地域の設定）に基づいて、人間が読みやすい文字列形式に変換して返します。