Temporal.PlainDate.prototype.with()

Syntax

with(info)
with(info, options)

Parameter

info

Ein Objekt, das mindestens eine der von Temporal.PlainDate.from() erkannten Eigenschaften enthält (außer calendar): day, era und eraYear, month, monthCode, year. Nicht spezifizierte Eigenschaften verwenden die Werte des ursprünglichen Datums. Sie müssen nur eine von month oder monthCode sowie eine von era und eraYear oder year angeben, und die andere wird entsprechend aktualisiert.

options Optional

Ein Objekt, das die folgende Eigenschaft enthält:

overflow Optional

Ein String, der das Verhalten bestimmt, wenn eine Datumskomponente außerhalb des Bereichs liegt. Mögliche Werte sind:

"constrain" (Standard)

Die Datumskomponente wird auf den gültigen Bereich eingeschränkt.

"reject"

Ein RangeError wird ausgelöst, wenn die Datumskomponente außerhalb des Bereichs liegt.

Rückgabewert

Ein neues Temporal.PlainDate-Objekt, bei dem die im info-Objekt angegebenen Felder, die nicht undefined sind, durch die entsprechenden Werte ersetzt werden, und die restlichen Felder des ursprünglichen Datums übernommen werden.

Ausnahmen

TypeError

Wird in einem der folgenden Fälle ausgelöst:

• info ist kein Objekt.
• options ist kein Objekt oder undefined.

RangeError

Wird in einem der folgenden Fälle ausgelöst:

• Die bereitgestellten Eigenschaften, die dieselbe Komponente angeben, sind inkonsistent.
• Die bereitgestellten nicht-numerischen Eigenschaften sind ungültig; zum Beispiel wenn monthCode niemals ein gültiger Monatscode in diesem Kalender ist.
• Die bereitgestellten numerischen Eigenschaften liegen außerhalb des Bereichs, und options.overflow ist auf "reject" gesetzt.
• Das Ergebnis liegt nicht im darstellbaren Bereich, der ±(10⁸ + 1) Tage, oder etwa ±273.972,6 Jahre, ab der Unix-Epoche umfasst.

Beispiele

Verwendung von with()

const date = Temporal.PlainDate.from("2021-07-06");
const newDate = date.with({ day: date.daysInMonth });
console.log(newDate.toString()); // 2021-07-31
const nextDecade = date.with({ year: date.year + 10 });
console.log(nextDecade.toString()); // 2031-07-06

Für weitere Beispiele, siehe die Dokumentation der individuellen Eigenschaften, die mithilfe von with() gesetzt werden können.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Temporal.PlainDate
• Temporal.PlainDate.prototype.withCalendar()
• Temporal.PlainDate.from()
• Temporal.PlainDate.prototype.add()
• Temporal.PlainDate.prototype.subtract()