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

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

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

作成日: 更新日:

基本的な使い方

Temporal.ZonedDateTime.prototype.toLocaleString()メソッドは、Temporal.ZonedDateTimeオブジェクトが保持する特定の日時とタイムゾーンの情報を、現在の実行環境または指定されたロケールに基づいた文字列形式に変換して返却するメソッドです。このメソッドの主な目的は、異なる言語や地域を使用するユーザーに対して、理解しやすい形式で日付と時刻を表示することです。

例えば、日本で実行された場合、このメソッドは日付を「年/月/日」形式、時刻を「時:分:秒」形式で表示し、タイムゾーン情報も付加します。一方、アメリカ合衆国で実行された場合は、「月/日/年」形式やAM/PM表記など、その地域の慣習に合わせた形式で表示されます。これにより、グローバルなアプリケーションにおいて、ユーザーの文化や習慣に沿った情報提示が可能となり、ユーザーエクスペリエンスが向上します。

このメソッドはオプションとして、ロケールを明示的に指定するための文字列や、表示形式を詳細に設定するためのオプションオブジェクトを受け取ることができます。オプションオブジェクトを使用すると、年、月、日、時、分、秒の各要素の表示スタイル(数値、2桁、長い形式など)や、タイムゾーン名の表示形式などを細かく制御することが可能です。これにより、開発者はアプリケーションの特定の要件に合わせて、日付と時刻の出力形式を柔軟にカスタマイズできます。システムエンジニアを目指す初心者にとって、このメソッドは国際化対応(i18n)の基礎を学び、多様なユーザーに対応するシステムを構築する上で非常に役立つでしょう。

構文(syntax)

1const zonedDateTimeInstance = new Temporal.ZonedDateTime(
2  Temporal.Instant.from('2023-10-27T10:30:00Z'),
3  'Europe/Berlin'
4);
5
6const formattedString = zonedDateTimeInstance.toLocaleString('de-DE', {
7  year: 'numeric',
8  month: '2-digit',
9  day: '2-digit',
10  hour: '2-digit',
11  minute: '2-digit',
12  timeZoneName: 'shortOffset'
13});

引数(parameters)

locales = undefined, options = undefined

  • locales: string | string[] | undefined: 地域の書式設定を指定する文字列または文字列の配列。省略された場合は、実行環境のデフォルトロケールが使用されます。
  • options: Intl.DateTimeFormatOptions | undefined: 書式設定のオプションを指定するオブジェクト。日付や時刻の表示形式などを細かく制御できます。

戻り値(return)

String

指定された日時オブジェクトを、実行環境のロケール(言語や地域設定)に基づいた、人間が読める形式の文字列に変換して返します。

関連コンテンツ

関連プログラミング言語