Temporal.PlainYearMonth.prototype.toString()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die toString() Methode von Instanzen von Temporal.PlainYearMonth gibt eine Zeichenkette zurück, die diesen Jahr-Monat im RFC 9557-Format darstellt.

Syntax

toString()
toString(options)

Parameter

options Optional

Ein Objekt, das die folgende Eigenschaft enthält:

calendarName Optional

Legt fest, ob die Kalenderanmerkung ([u-ca=calendar_id]) im Rückgabewert angezeigt wird. Mögliche Werte sind:

"auto" (Standard): Schließt die Kalenderanmerkung ein, wenn der Kalender nicht "iso8601" ist. Der Referenztag wird einbezogen, wenn der Kalender nicht "iso8601" ist.
"always": Die Kalenderanmerkung wird immer einbezogen. Der Referenztag wird ebenfalls immer einbezogen.
"never": Die Kalenderanmerkung wird nie einbezogen. Dadurch wird die zurückgegebene Zeichenkette nicht auf dieselbe Temporal.PlainYearMonth Instanz zurückführbar, obwohl der Jahr-Monat-Wert weiterhin derselbe bleibt. Der Referenztag wird einbezogen, wenn der Kalender nicht "iso8601" ist.
"critical": Die Kalenderanmerkung wird immer einbezogen und ein kritisches Flag hinzugefügt: [!u-ca=calendar_id]. Nützlich beim Senden der Zeichenkette an bestimmte Systeme, aber nicht nützlich für Temporal selbst. Der Referenztag wird ebenfalls immer einbezogen.

Eine Zeichenkette im RFC 9557-Format, die diesen Jahr-Monat darstellt. Die Kalenderanmerkung ist wie angegeben enthalten. Der Referenztag ist enthalten, wenn eine Kalenderanmerkung enthalten ist oder wenn der Kalender nicht "iso8601" ist.

Ausnahmen

RangeError: Wird ausgelöst, wenn einer der Optionen ungültig ist.
TypeError: Wird ausgelöst, 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

Specification
Temporal # sec-temporal.plainyearmonth.prototype.tostring