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

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

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

作成日: 更新日:

基本的な使い方

Temporal.PlainDate.prototype.toLocaleString()メソッドは、Temporal.PlainDateオブジェクトに格納されている日付情報を、ユーザーが指定した言語や地域の形式、および設定オプションに基づいて、読みやすい文字列形式に変換するために実行されるメソッドです。このメソッドは、世界中の様々なユーザーに対応するアプリケーション、いわゆる国際化(i18n)対応アプリケーションにおいて、日付をその地域の慣習に沿って正確に表示する際に非常に重要です。

このメソッドには、主に二つのオプションの引数を渡すことができます。一つ目はlocalesで、これは日付をどのようにフォーマットするかを示す言語タグや地域の識別子を、文字列または文字列の配列で指定します。例えば、'ja-JP'を指定すれば日本の日付形式に、'en-US'を指定すればアメリカ英語の日付形式に変換されます。この引数を省略すると、実行環境の標準設定が適用されます。

二つ目の引数はoptionsで、これは日付の表示形式を細かく制御するためのオブジェクトです。例えば、年を西暦の4桁で表示するか、月を数字ではなく「一月」のように漢字で表示するか、日を数字で表示するかなど、表示の仕方を柔軟に調整できます。

最終的に、このメソッドは指定されたロケールとオプションに従って整形された日付の文字列を返します。これにより、システムエンジニアは、どのような地域や言語のユーザーであっても、それぞれの文化や習慣に合った日付の表現を簡単に提供できるようになります。これは、アプリケーションのユーザーエクスペリエンスを向上させる上で不可欠な機能と言えます。

構文(syntax)

1plainDate.toLocaleString([locales[, options]])

引数(parameters)

locales, options

  • locales: string | string[] | undefined: 日付の書式設定に使用するロケールを指定します。省略した場合、実行環境のデフォルトロケールが使用されます。
  • options: Intl.DateTimeFormatOptions | undefined: 日付の書式設定の詳細なオプションを指定します。

戻り値(return)

String

このメソッドは、Temporal.PlainDateオブジェクトを、実行環境の現在のロケール(地域と言語の設定)に応じた人間が読みやすい文字列形式に変換した結果を返します。

関連コンテンツ

関連プログラミング言語