Temporal.PlainMonthDay.from()

Syntax

Temporal.PlainMonthDay.from(info)
Temporal.PlainMonthDay.from(info, options)

Parameter

info

Eines der folgenden:

• Eine Temporal.PlainMonthDay-Instanz, die eine Kopie der Instanz erstellt.
• Ein RFC 9557-String, welcher ein Datum und optional einen Kalender enthält. Wenn der Kalender nicht iso8601 ist, ist ein Jahr 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.PlainMonthDay()-Konstruktor, der die Werte im ISO-Kalendersystem interpretiert). Siehe Intl.supportedValuesOf() für eine Liste der allgemein unterstützten Kalendertypen.

  day

  Eine Ganzzahl, die der day-Eigenschaft entspricht. Muss positiv sein, unabhängig von der overflow-Option.

  era und eraYear

  Ein String und eine Ganzzahl, die anstelle von year verwendet werden können. Siehe era und eraYear von PlainDate. Werden nur verwendet, wenn das Kalendersystem Ären hat. era und eraYear müssen gleichzeitig bereitgestellt werden. Wenn month angegeben ist, muss mindestens eines von eraYear (zusammen mit era) oder year bereitgestellt werden. Wenn alle von era, eraYear und year bereitgestellt werden, müssen sie konsistent sein.

  month

  Eine positive Ganzzahl, die anstelle von monthCode verwendet werden kann. Siehe month von PlainDate. Muss positiv sein, unabhängig von der overflow-Option. Wenn month bereitgestellt wird und der Kalender nicht iso8601 ist, muss auch year (oder eraYear zusammen mit era als Ersatz) bereitgestellt werden, da derselbe month zu mehreren möglichen monthCode-Werten in verschiedenen Jahren führen kann. Mindestens eines von month oder monthCode muss bereitgestellt werden. Wenn sowohl month als auch monthCode bereitgestellt werden, müssen sie konsistent sein.

  monthCode

  Entspricht der monthCode-Eigenschaft. Mindestens eines von month oder monthCode muss bereitgestellt werden. Wenn sowohl month als auch monthCode bereitgestellt werden, müssen sie konsistent sein.

  year

  Eine Ganzzahl, die zur Unterscheidung von month verwendet wird, wenn bereitgestellt, da für einige Kalender derselbe month je nach Jahr unterschiedliche monthCode bedeutet. Siehe year von PlainDate. Wenn ein Jahr bereitgestellt wird, validiert die overflow-Option den Monat-Tag im angegebenen Jahr, nicht nur in einem beliebigen Jahr. Wenn month spezifiziert ist, muss mindestens eines von eraYear (zusammen mit era) oder year bereitgestellt werden. Wenn alle von era, eraYear und year bereitgestellt werden, müssen sie konsistent sein.

options Optional

Ein Objekt, das die folgende Eigenschaft enthält:

overflow Optional

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

"constrain" (Standard)

Die Datums-Komponente wird auf den gültigen Bereich eingeschränkt.

"reject"

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

Rückgabewert

Ein neues Temporal.PlainMonthDay-Objekt, das den Monat und Tag repräsentiert, die durch info im angegebenen calendar spezifiziert sind.

Jedes PlainMonthDay speichert intern ein komplettes ISO 8601-Datum, das denselben Monat-Tag im Zielkalender hat wie das, was ausgegeben wird. Das Bezugsjahr wird sichtbar, wenn es mit toString() als ISO-Datum ausgegeben wird. Das Bezugsjahr wird willkürlich, aber konsistent gewählt (d.h. jedes (monthCode, day)-Paar wird immer auf dasselbe ISO-Bezugsjahr abgebildet). Es verwendet nicht das im Eingabewert angegebene Jahr. Stattdessen wird das Bezugsjahr bestimmt, indem das neueste Datum vor dem 31. Dezember 1972, das denselben Monat-Tag im Zielkalender hat, oder das früheste Datum nach dem 31. Dezember 1972 gewählt wird, wenn kein solches Datum existiert.

Zum Beispiel für gregorianische Kalender ist das Bezugsjahr 1972. Für den hebräischen Kalender ist das Bezugsjahr 1972 im gregorianischen Kalender, aber wenn der Monat Adar I (M05L) ist, der ein Schaltmonat ist, ist das Bezugsjahr 1970 (5730 im hebräischen Kalender), da das nächste Schaltjahr 1973 (5733 im hebräischen Kalender) ist, was nach 1972 liegt.

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

Ausnahmen

TypeError

Wird in einem der folgenden Fälle geworfen:

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

RangeError

Wird in einem der folgenden Fälle geworfen:

• Die bereitgestellten Eigenschaften, die dieselbe Komponente spezifizieren, sind inkonsistent.
• Die bereitgestellten nicht-numerischen Eigenschaften sind nicht gültig, zum Beispiel, wenn monthCode niemals ein gültiger Monatscode in diesem Kalender ist.
• Die bereitgestellten numerischen Eigenschaften sind 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 beträgt.

Beispiele

Erstellen eines PlainMonthDay aus einem Objekt

// Month code + day
const md = Temporal.PlainMonthDay.from({ monthCode: "M05", day: 2 });
console.log(md.toString()); // 05-02

// Month + day (only for ISO calendar)
const md2 = Temporal.PlainMonthDay.from({ month: 7, day: 1 });
console.log(md2.toString()); // 07-01

// Year + month + day
const md3 = Temporal.PlainMonthDay.from({ year: 2021, month: 7, day: 1 });
console.log(md3.toString()); // 07-01

// Year + month + day in a different calendar (where year is required)
const md4 = Temporal.PlainMonthDay.from({
  year: 2021,
  month: 7,
  day: 1,
  calendar: "hebrew",
});
console.log(md4.toString()); // 1972-03-16[u-ca=hebrew]

// Month code + day in a different calendar
const md5 = Temporal.PlainMonthDay.from({
  monthCode: "M05L",
  day: 1,
  calendar: "hebrew",
});
console.log(md5.toString()); // 1970-02-07[u-ca=hebrew]

Steuerung des Überlaufverhaltens

Standardmäßig werden Werte, die außerhalb des Bereichs liegen, auf den gültigen Bereich begrenzt. Ein Monat-Tag ohne ausdrückliches Bezugsjahr ist gültig, solange es ein Jahr gibt, in dem es gültig ist, auch wenn es nicht jedes Jahr erscheint. Wenn Jahr, Monat und Tag alle angegeben sind, können die Regeln zur Abbildung auf einen gültigen Monat-Tag komplex und spezifisch für jeden Kalender sein, aber hier ist das übliche Verhalten:

• Wenn die year/month-Kombination ungültig ist, wird month eingeschränkt, um einen gültigen monthCode im Jahr zu erhalten.
• Wenn die year/monthCode-Kombination ungültig ist, wird ein anderes Jahr gewählt, um den monthCode beizubehalten.
• day wird im gegebenen Jahr-Monat eingeschränkt, um einen gültigen Monat-Tag zu erhalten.

Dies unterscheidet sich leicht von der üblichen Datumseinschränkung, die das Jahr dem Monatcode vorzieht.

// Month always out of range
const md1 = Temporal.PlainMonthDay.from({ month: 13, day: 1 });
console.log(md1.toString()); // 12-01

// Month out of range for the specific year: 5732 is not a Hebrew leap year,
// so month is clamped to 12 to resolve to a valid monthCode
const md2 = Temporal.PlainMonthDay.from({
  year: 5732,
  month: 13,
  day: 1,
  calendar: "hebrew",
});
console.log(md2.toLocaleString("en-US", { calendar: "hebrew" })); // 1 Elul
const underlyingDate = Temporal.PlainDate.from(md2.toString());
console.log(underlyingDate.year, underlyingDate.month); // 5732 12

// Month code exists but not for the specific year: 5731 is not a Hebrew leap year,
// so a different year is chosen to keep the monthCode as M05L
const md3 = Temporal.PlainMonthDay.from({
  year: 5731,
  monthCode: "M05L",
  day: 1,
  calendar: "hebrew",
});
console.log(md3.toLocaleString("en-US", { calendar: "hebrew" })); // 1 Adar I
const underlyingDate2 = Temporal.PlainDate.from(md3.toString());
console.log(underlyingDate2.year, underlyingDate2.monthCode); // 5730 M05L

// Day always out of range
const md4 = Temporal.PlainMonthDay.from({ month: 2, day: 30 });
console.log(md4.toString()); // 02-29

// Day out of range for the specific year-month
const md5 = Temporal.PlainMonthDay.from({ year: 2021, month: 2, day: 29 });
console.log(md5.toString()); // 02-28

Sie können dieses Verhalten ändern, um stattdessen einen Fehler zu werfen:

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

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Temporal.PlainMonthDay
• Temporal.PlainMonthDay()
• Temporal.PlainMonthDay.prototype.with()