Temporal.PlainYearMonth.prototype.toString()

Syntax

toString()
toString(options)

Parameter

options Optional

Ein Objekt mit folgender Eigenschaft:

calendarName Optional

Gibt an, ob die Kalenderanmerkung ([u-ca=calendar_id]) im Rückgabewert angezeigt werden soll. Mögliche Werte sind:

"auto" (Standard)

Die Kalenderanmerkung wird eingeschlossen, wenn der Kalender nicht "iso8601" ist. Der Bezugstag wird eingeschlossen, wenn der Kalender nicht "iso8601" ist.

"always"

Die Kalenderanmerkung wird immer eingeschlossen. Der Bezugstag wird ebenfalls immer eingeschlossen.

"never"

Die Kalenderanmerkung wird nie eingeschlossen. Dies führt dazu, dass der zurückgegebene String nicht auf die gleiche Temporal.PlainYearMonth-Instanz zurückführbar ist, obwohl der Jahr-Monat-Wert gleich bleibt. Der Bezugstag wird eingeschlossen, wenn der Kalender nicht "iso8601" ist.

"critical"

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

Rückgabewert

Ein String im RFC 9557-Format, der diesen Jahr-Monat repräsentiert. Die Kalenderanmerkung ist wie angegeben enthalten. Der Bezugstag ist enthalten, wenn eine Kalenderanmerkung enthalten ist oder wenn der Kalender nicht "iso8601" ist.

Ausnahmen

RangeError

Wird ausgelöst, wenn eine 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

Browser-Kompatibilität

Siehe auch

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