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

Temporal.PlainYearMonth.prototype.toLocaleString()メソッドは、Temporal.PlainYearMonthオブジェクトが保持する年と月の情報を、ユーザーの言語や地域の慣習に基づいた、読みやすい文字列形式に変換して返すメソッドです。Temporal.PlainYearMonthオブジェクトは、特定のタイムゾーンや具体的な日付情報を持たず、純粋な年と月のみを扱うためのモダンなオブジェクトとして設計されています。

このメソッドを使用すると、アプリケーションのユーザーが利用しているロケール（地域設定）に合わせて、年月の表示形式を自動的に調整できます。例えば、内部的に「2023年1月」を表すデータがある場合、日本のユーザーには「2023年1月」と、アメリカのユーザーには「January 2023」といった形で、それぞれの地域の慣習に合った読みやすい形式で表示することが可能です。これは、多言語対応や国際化対応（i18n）が必要なシステムを開発する際に非常に役立ちます。

メソッドには、引数としてロケール識別子（例: 'en-US'や'ja-JP')や、表示スタイルなどを細かく設定するためのオプションオブジェクトを渡すことができます。これらの引数を省略した場合、JavaScriptが実行されている環境のデフォルト設定が適用されます。この機能により、開発者は複雑な日付の書式設定ロジックを自分で実装する手間を省き、より簡潔にユーザーインターフェースの国際化を実現できます。

Copy
1const plainYearMonth = new Temporal.PlainYearMonth(2023, 1);
2const formattedString = plainYearMonth.toLocaleString('en-US', { calendar: 'iso8601' });

locales, options

• locales: string | string[] | undefined: 地域と言語の指定。省略した場合、実行環境のデフォルト設定が使用される。
• options: Intl.DateTimeFormatOptions | undefined: 書式設定のオプションを指定するオブジェクト。

string

引数で指定されたロケール（地域と言語の組み合わせ）およびオプションに基づいて、Temporal.PlainYearMonth オブジェクトを人間が読みやすい文字列形式に変換したものを返します。