Temporal.PlainYearMonth : méthode subtract()

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 subtract() des instances de Temporal.PlainYearMonth retourne un nouvel objet Temporal.PlainYearMonth représentant ce mois et cette année reculés d'une durée donnée (sous une forme convertible par Temporal.Duration.from()).

Si vous souhaitez soustraire deux mois et obtenir une durée, utilisez plutôt since() ou until().

Syntaxe

subtract(duration)
subtract(duration, options)

Paramètres

duration

Une chaîne de caractères, un objet ou une instance de Temporal.Duration représentant une durée à soustraire de ce mois et cette année. Elle est convertie en un 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.PlainYearMonth représentant l'année et le mois spécifiés par le PlainYearMonth d'origine, moins la durée.

Exceptions

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

const start = Temporal.PlainYearMonth.from("2022-01");
const end = start.subtract({ years: 1, months: 2, weeks: 3, days: 4 });
console.log(end.toString()); // 2020-11

Pour plus d'exemples, voir add().