Temporal.PlainDateTime : méthode add()

Disponibilité limitée

Cette fonctionnalité n'est pas Compatible car elle ne fonctionne pas dans certains des navigateurs les plus utilisés.

La méthode add() des instances de Temporal.PlainDateTime retourne un nouvel objet Temporal.PlainDateTime représentant cette valeur de date et d'heure avancée d'une durée donnée (sous une forme convertible par Temporal.Duration.from()).

Syntaxe

add(duration)
add(duration, options)

Paramètres

duration

Une chaîne de caractères, un objet ou une instance de Temporal.Duration représentant une durée à ajouter à cette date et heure. Elle est convertie en objet Temporal.Duration en utilisant le même algorithme que Temporal.Duration.from().

options Facultatif

Un objet contenant la propriété suivante :

overflow Facultatif

Une chaîne de caractères définissant le comportement lorsque un composant de date est hors de portée. Les valeurs possibles sont :

"constrain" (par défaut): Le composant de date est contraint à la plage valide.
"reject": Un objet RangeError est levé si le composant de date est hors de portée.

Valeur de retour

Un nouvel objet Temporal.PlainDateTime représentant la date et l'heure définies par le PlainDateTime d'origine, plus la durée.

Exceptions

RangeError: Levée si le résultat n'est pas dans la plage représentable, qui est ±(10⁸ + 1) jours, soit environ ±273 972,6 ans, à partir de l'époque Unix.

const start = Temporal.PlainDateTime.from("2021-01-01T12:34:56");
const end = start.add({
  years: 1,
  months: 2,
  weeks: 3,
  days: 4,
  hours: 5,
  minutes: 6,
  seconds: 7,
  milliseconds: 8,
});
console.log(end.toString()); // 2022-03-26T17:41:03.008

Pour plus d'exemples, en particulier sur la façon dont différents calendriers et l'option overflow interagissent avec les durées calendaires, voir Temporal.PlainDate.prototype.add().