Temporal.PlainYearMonth.from()

info

Einer der folgenden:

• Eine Temporal.PlainYearMonth Instanz, die eine Kopie der Instanz erstellt.
• Ein RFC 9557 String, der ein Datum und optional einen Kalender enthält. Wenn der Kalender nicht iso8601 ist, ist ein Tag erforderlich.
• Ein Objekt, das die folgenden Eigenschaften enthält (in der Reihenfolge, in der sie abgerufen und validiert werden):

  calendar Optional

  Ein String, der der calendarId Eigenschaft entspricht. Standardmäßig "iso8601". Alle anderen Eigenschaften werden in diesem Kalendersystem interpretiert (im Gegensatz zum Temporal.PlainYearMonth() Konstruktor, der die Werte im ISO-Kalendersystem interpretiert).

  era und eraYear

  Ein String und eine Ganzzahl, die den era und eraYear Eigenschaften entsprechen. Werden nur verwendet, wenn das Kalendersystem Epochen hat. era und eraYear müssen gleichzeitig angegeben werden. Wenn sie nicht angegeben werden, muss year angegeben werden. Wenn alle era, eraYear und year angegeben werden, müssen sie konsistent sein.

  month

  Entspricht der month Eigenschaft. Muss unabhängig von der overflow-Option positiv sein.

  monthCode

  Entspricht der monthCode Eigenschaft. Wenn es nicht angegeben wird, muss month angegeben werden. Wenn sowohl month als auch monthCode angegeben werden, müssen sie konsistent sein.

  year

  Entspricht der year Eigenschaft.

options Optional

Ein Objekt mit der folgenden Eigenschaft:

overflow Optional

Ein String, der das Verhalten angibt, wenn eine Datumskomponente außerhalb des Bereichs liegt (bei Verwendung des Objekt-info). Mögliche Werte sind:

"constrain" (Standard)

Die Datumskomponente wird auf den gültigen Bereich begrenz.

"reject"

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

Ein neues Temporal.PlainYearMonth-Objekt, das das Jahr und den Monat darstellt, die durch info im angegebenen calendar spezifiziert werden.

Jede PlainYearMonth speichert intern ein vollständiges ISO 8601-Datum, das denselben Jahr-Monat im Zielkalender hat, wie in der Ansicht gezeigt wird. Der Referenztag ist sichtbar, wenn er mit toString() als ISO-Datum konvertiert wird. Der Referenztag wird willkürlich aber konstant gewählt; das heißt, jedes (year, month) Paar wird immer auf denselben ISO-Referenztag abgebildet. Er verwendet nicht den im Eingabewert angegebenen Tag. Stattdessen wird der Referenztag immer als der erste gültige Tag des Monats gewählt.

Diese Referenztag-Kanonisierung stellt sicher, dass equals() die zugrunde liegenden ISO-Daten direkt vergleichen kann, ohne zusätzliche Berechnungen.

TypeError

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

• info ist kein Objekt oder String.
• options ist kein Objekt oder undefined.
• Die bereitgestellten Eigenschaften sind unzureichend, um ein Datum eindeutig zu bestimmen. Normalerweise müssen Sie year (oder era und eraYear) und month (oder einen monthCode) bereitstellen.

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 nicht gültig; zum Beispiel, wenn monthCode nie ein gültiger Monatscode in diesem Kalender ist.
• Die bereitgestellten numerischen Eigenschaften liegen außerhalb des Bereichs, und options.overflow ist auf "reject" gesetzt.
• Die Info liegt nicht im darstellbaren Bereich, der ±(10⁸ + 1) Tage, oder etwa ±273.972,6 Jahre, ab der Unix-Epoche umfasst.

Standardmäßig werden Werte außerhalb des Bereichs auf den gültigen Bereich begrenzt.

const ym1 = Temporal.PlainYearMonth.from({ year: 2021, month: 13 });
console.log(ym1.toString()); // 2021-12

// 5732 is not a Hebrew leap year, so a different monthCode is chosen
const ym2 = Temporal.PlainYearMonth.from({
  year: 5732,
  monthCode: "M05L",
  calendar: "hebrew",
});
console.log(ym2.toLocaleString("en-US", { calendar: "hebrew" })); // Adar 5732
const underlyingDate = Temporal.PlainDate.from(ym2.toString());
console.log(underlyingDate.year, underlyingDate.monthCode); // 5732 M06

Sie können dieses Verhalten ändern, um stattdessen einen Fehler auszulösen:

Temporal.PlainYearMonth.from({ year: 2021, month: 13 }, { overflow: "reject" });
// RangeError: date value "month" not in 1..12: 13

• Temporal.PlainYearMonth
• Temporal.PlainYearMonth()
• Temporal.PlainYearMonth.prototype.with()