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

Date.prototype.toLocaleTimeString()メソッドは、JavaScriptのDateオブジェクトに格納されている時刻情報を取り出し、それを特定の地域（ロケール）の規則に基づいて整形し、文字列として表現するメソッドです。このメソッドは、Dateインスタンスに対して直接呼び出されます。

主な機能として、日付オブジェクトから時間、分、秒といった時刻の部分を抽出し、指定された言語や地域に応じた形式に変換します。これにより、例えば日本では「時:分:秒」の形式で、アメリカでは「AM/PM」を含む形式で時刻を表示するといった、利用者にとって自然な時刻表現を簡単に実現できます。

このメソッドは、二つのオプション引数を受け取ります。一つ目のlocales引数は、時刻の表示に使用する言語と地域の書式規則を指定するための文字列、または文字列の配列です。例えば、'ja-JP'を指定すると日本語のロケールが適用されます。二つ目のoptions引数は、時間や分の表示形式（例: hour, minute, secondプロパティ）や、12時間表記か24時間表記か（hour12プロパティ）など、時刻の表示に関する詳細な設定を行うためのオブジェクトです。これらの引数を省略した場合、実行環境のデフォルト設定が使用されます。

このメソッドを利用することで、国際化されたアプリケーションにおいて、ユーザーのいる地域に合わせた適切な時刻のフォーマットを自動的に提供できるため、開発者は地域ごとの書式設定を個別に実装する手間を省くことができます。最終的に、整形された時刻を表す文字列が戻り値として返されます。

Copy
1const date = new Date();
2date.toLocaleTimeString();

locales, options

• locales: string | string[] (省略可): 表示に使用するロケール（言語と地域）を指定します。例: "ja-JP"（日本語）、"en-US"（アメリカ英語）。配列で指定すると、優先順位の高い順にロケールが試されます。
• options: object (省略可): 表示形式をカスタマイズするためのオプションを指定します。例えば、時、分、秒、タイムゾーンなどを表示するかどうかを設定できます。

String

指定されたロケール（言語・地域）の書式に基づいた、ローカルタイム文字列を返します。