Temporal.PlainYearMonth.prototype.toString()

Syntax

toString()
toString(options)

Parameter

options Optional

Ein Objekt, das die folgende Eigenschaft enthält:

calendarName Optional

Ob die Kalenderannotation ([u-ca=calendar_id]) im Rückgabewert gezeigt werden soll. Mögliche Werte sind:

"auto" (Standard)

Die Kalenderannotation wird hinzugefügt, wenn der Kalender nicht "iso8601" ist. Der Referenztag ist enthalten, wenn der Kalender nicht "iso8601" ist.

"always"

Die Kalenderannotation wird immer hinzugefügt. Der Referenztag ist ebenfalls immer enthalten.

"never"

Die Kalenderannotation wird nie hinzugefügt. Dies macht den zurückgegebenen String nicht wiederherstellbar zur gleichen Temporal.PlainYearMonth Instanz, obwohl der Jahr-Monat-Wert gleich bleibt. Der Referenztag ist enthalten, wenn der Kalender nicht "iso8601" ist.

"critical"

Die Kalenderannotation wird immer hinzugefügt und ein kritisches Flag hinzugefügt: [!u-ca=calendar_id]. Nützlich beim Senden des Strings an bestimmte Systeme, aber nicht nützlich für Temporal selbst. Der Referenztag ist ebenfalls immer enthalten.

Rückgabewert

Ein String im RFC 9557 Format, der diesen Jahr-Monat darstellt. Die Kalenderannotation ist wie angegeben enthalten. Der Referenztag ist enthalten, wenn eine Kalenderannotation enthalten ist oder wenn der Kalender nicht "iso8601" ist.

Ausnahmen

RangeError

Wird geworfen, wenn eine der Optionen ungültig ist.

TypeError

Wird geworfen, wenn options kein Objekt oder undefined ist.

Beispiele

Verwendung von toString()

const ym = Temporal.PlainYearMonth.from({ year: 2021, month: 8 });
console.log(ym.toString()); // '2021-08'

const ym2 = Temporal.PlainYearMonth.from({
  year: 4658,
  monthCode: "M08",
  calendar: "chinese",
});
console.log(ym2.toString()); // '2021-09-07[u-ca=chinese]'

Verwendung von Optionen

const isoYM = Temporal.PlainYearMonth.from({ year: 2021, month: 8 });
const ym = Temporal.PlainYearMonth.from({
  year: 4658,
  monthCode: "M08",
  calendar: "chinese",
});
console.log(isoYM.toString({ calendarName: "auto" })); // '2021-08'
console.log(ym.toString({ calendarName: "auto" })); // '2021-09-07[u-ca=chinese]'
console.log(isoYM.toString({ calendarName: "always" })); // '2021-08-01[u-ca=iso8601]'
console.log(ym.toString({ calendarName: "always" })); // '2021-09-07[u-ca=chinese]'
console.log(isoYM.toString({ calendarName: "never" })); // '2021-08'
console.log(ym.toString({ calendarName: "never" })); // '2021-09-07'
console.log(isoYM.toString({ calendarName: "critical" })); // '2021-08-01[!u-ca=iso8601]'
console.log(ym.toString({ calendarName: "critical" })); // '2021-09-07[!u-ca=chinese]'

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Temporal.PlainYearMonth
• Temporal.PlainYearMonth.from()
• Temporal.PlainYearMonth.prototype.toJSON()
• Temporal.PlainYearMonth.prototype.toLocaleString()