【JavaScript ECMAScript】Temporal::Temporal.PlainTime.prototype.toLocaleStringインスタンスメソッドの使い方
Temporal.PlainTime.prototype.toLocaleString()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainTime.prototype.toLocaleString()メソッドは、日付情報を含まない時刻を表すTemporal.PlainTimeオブジェクトの時刻を、特定のロケール(地域や言語)に合わせた書式の文字列に変換して返します。このメソッドは、主にユーザーインターフェースで時刻を表示する際に、国際化対応を容易にすることを目的としています。
引数としてlocalesとoptionsを受け取ります。locales引数には、言語タグ(例: 'ja-JP'や'en-US'など)を指定することで、表示される時刻の言語や地域に応じた書式を設定できます。これにより、日本であれば「午前9時30分」のように、アメリカであれば「9:30 AM」のように表示形式が自動的に調整されます。options引数を使用すると、時刻の表示形式をさらに詳細に制御することが可能です。例えば、24時間表記か12時間表記か、秒まで表示するかどうか、時間帯の表示方法などを細かく指定できます。
このメソッドを利用することで、開発者は、様々な地域のユーザーに対して、その文化や習慣に適した時刻表示を簡単に提供できます。Temporal APIは、JavaScriptにおける日付と時刻の処理をより堅牢で使いやすくするために導入された新しい標準であり、このtoLocaleString()メソッドはその国際化機能の一部として重要な役割を果たします。
構文(syntax)
1const plainTime = new Temporal.PlainTime(13, 30, 0); 2const formattedString = plainTime.toLocaleString('en-US', { hour: '2-digit', minute: '2-digit', second: '2-digit' });
引数(parameters)
locales, options
- locales: string | string[] | undefined: ロケールを指定します。省略すると、実行環境のデフォルトロケールが使用されます。
- options: Intl.DateTimeFormatOptions | undefined: フォーマットのオプションを指定します。
戻り値(return)
String
このメソッドは、Temporal.PlainTimeオブジェクトの時刻を、実行環境の現在のロケール(地域設定)に合わせて整形した文字列を返します。