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

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

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

作成日: 更新日:

基本的な使い方

Date.prototype.toLocaleString()メソッドは、Dateオブジェクトが保持する日付と時刻の情報を、指定された言語と地域(ロケール)に応じた書式の文字列に変換して返すメソッドです。

このメソッドは、引数を指定しない場合、JavaScriptが実行されている環境のデフォルトロケール設定に基づいて、日付と時刻を整形し、読みやすい形式で出力します。例えば、日本で使用された場合は「2023/12/31 15:30:00」のように、アメリカで使用された場合は「12/31/2023, 3:30:00 PM」のように、それぞれの文化圏で一般的な表示形式に自動調整されます。

さらに、第一引数に言語環境を示すロケール文字列(例: 'ja-JP''en-US')を、第二引数に書式設定の詳細を指定するオプションオブジェクトを渡すことで、表示形式を細かく制御できます。オプションオブジェクトでは、年の表示スタイル(2桁、4桁)、月の表示方法(数字、短い名前、長い名前)、曜日、時、分、秒の有無やスタイル、タイムゾーンなどを柔軟に設定することが可能です。

このように、Date.prototype.toLocaleString()メソッドは、異なる地域や言語を使用するユーザーに対して、それぞれに適した形式で日付や時刻を表示する国際化(i18n)対応のWebアプリケーションなどを開発する際に非常に有用です。戻り値は、指定されたロケールとオプションで整形された日付と時刻を表す文字列となります。

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

構文(syntax)

1const date = new Date();
2const formattedString = date.toLocaleString();

引数(parameters)

locales, options

  • locales: string | string[] | undefined: 日付と時刻の文字列をフォーマットする際に使用するロケール(言語と地域)を指定します。省略した場合は、実行環境のデフォルトロケールが使用されます。
  • options: Intl.DateTimeFormatOptions | undefined: 日付と時刻のフォーマット方法を細かく指定するためのオプションオブジェクトです。年、月、日、時、分、秒などの表示形式や、タイムゾーン、カレンダーの種類などを設定できます。

戻り値(return)

String

このメソッドは、Dateオブジェクトの値を、実行環境のロケール(地域設定)に基づいた、人間が読みやすい文字列形式で返します。

関連コンテンツ

関連プログラミング言語