Temporal.PlainYearMonth : méthode since()

Syntaxe

since(other)
since(other, options)

Paramètres

other

Une chaîne de caractères, un objet ou une instance de Temporal.PlainYearMonth représentant le mois et l'année à soustraire de ce mois et son année. Il est converti en un objet Temporal.PlainYearMonth en utilisant le même algorithme que Temporal.PlainYearMonth.from(). Il doit avoir le même calendrier que this.

options Facultatif

Un objet contenant les options pour Temporal.Duration.prototype.round(), qui inclut largestUnit, roundingIncrement, roundingMode et smallestUnit. largestUnit et smallestUnit n'acceptent que les unités : "years", "months", ou leurs formes singulières. Pour largestUnit, la valeur par défaut "auto" signifie "years". Pour smallestUnit, la valeur par défaut est "months". La date actuelle est utilisée comme option relativeTo.

Valeur de retour

Un nouvel objet Temporal.Duration représentant la durée depuis other jusqu'à ce mois et cette année. La durée est positive si other est avant ce mois et cette année, et négative si après.

Exceptions

RangeError

Levée dans l'un des cas suivants :

• other a un calendrier différent de this.
• L'une des options est invalide.

Exemples

Utiliser la méthode since()

const lastUpdated = Temporal.PlainYearMonth.from("2022-01");
const now = Temporal.Now.plainDateISO().toPlainYearMonth();
const duration = now.since(lastUpdated);
console.log(`Dernière mise à jour il y a ${duration.toLocaleString("en-US")}`);
// Sortie attendue : "Dernière mise à jour il y a [number] années, [number] mois"

const duration2 = now.since(lastUpdated, { largestUnit: "months" });
console.log(`Dernière mise à jour il y a ${duration2.toLocaleString("en-US")}`);
// Sortie attendue : "Dernière mise à jour il y a [number] mois"

const duration3 = now.since(lastUpdated, { smallestUnit: "years" });
console.log(`Dernière mise à jour il y a ${duration3.toLocaleString("en-US")}`);
// Sortie attendue : "Dernière mise à jour il y a [number] années"

Arrondir le résultat

Par défaut, la partie fractionnaire de smallestUnit est tronquée. Vous pouvez l'arrondir en utilisant les options roundingIncrement et roundingMode.

const ym1 = Temporal.PlainYearMonth.from("2022-01");
const ym2 = Temporal.PlainYearMonth.from("2022-11");
const duration = ym2.since(ym1, {
  smallestUnit: "years",
  roundingMode: "ceil",
});
console.log(duration.toString()); // "P1Y"

Obtenir le résultat en jours

Par défaut, la durée résultante ne contient jamais de jours, car PlainYearMonth n'offre pas de précision au niveau des jours. Vous pouvez obtenir le résultat en jours en le convertissant d'abord en un Temporal.PlainDate avec un jour qui n'est pas ambigu.

const ym1 = Temporal.PlainYearMonth.from("2022-01");
const ym2 = Temporal.PlainYearMonth.from("2022-11");
const duration = ym2.toPlainDate({ day: 1 }).since(ym1.toPlainDate({ day: 1 }));
console.log(duration.toString()); // "P304D"

Spécifications

Compatibilité des navigateurs

Voir aussi

• L'objet Temporal.PlainYearMonth
• L'objet Temporal.Duration
• La méthode Temporal.PlainYearMonth.prototype.add()
• La méthode Temporal.PlainYearMonth.prototype.subtract()
• La méthode Temporal.PlainYearMonth.prototype.until()