【JavaScript ECMAScript】Temporal::Temporal.PlainMonthDay.prototype.toStringインスタンスメソッドの使い方
Temporal.PlainMonthDay.prototype.toString()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
Temporal.PlainMonthDay.prototype.toString()メソッドは、Temporal.PlainMonthDayオブジェクトが持つ月と日の情報を、標準的な文字列形式で表現するメソッドです。
Temporal.PlainMonthDayオブジェクトは、特定の年の情報やタイムゾーンを持たず、月と日のみを独立して管理するためのオブジェクトです。このtoString()メソッドは、そのPlainMonthDayインスタンスが保持している月と日のデータを、人間が読みやすく、かつプログラミング言語間で交換しやすいISO 8601形式の文字列に変換します。
具体的な出力形式は、「--MM-DD」のようになります。もしPlainMonthDayオブジェクトが特定のカレンダーシステムの情報(例えば、日本の和暦など)を保持している場合、そのカレンダー識別子も文字列の末尾に「[u-ca=calendarId]」という形式で追加されます。これにより、単なる月日だけでなく、それがどのカレンダーに基づくものなのかも一目で確認できます。
このメソッドは、オプションとしてオブジェクトを受け取ることができ、そのオプションを通じて出力される文字列の形式をより詳細に制御することが可能です。例えば、数値の最小桁数を指定したり、カレンダー情報の表示方法を調整したりすることができます。デバッグ時にオブジェクトの内容を確認したり、アプリケーションのユーザーインターフェースで月日を表示したりする際に、このメソッドは非常に役立ちます。
構文(syntax)
1const plainMonthDay = new Temporal.PlainMonthDay(7, 1); 2const monthDayString = plainMonthDay.toString();
引数(parameters)
options = undefined
- options: object | undefined: フォーマットオプションを指定するオブジェクト。省略された場合はデフォルトのフォーマットが使用されます。
戻り値(return)
string
このメソッドは、Temporal.PlainMonthDayオブジェクトを、MM-DDの形式の文字列で表現したものを返します。