`$cal.add`¶

Description¶

Méthode d'addition de dates, heures ou timestamps.

Syntaxe¶

$cal.add( ref , amount , unit )

Paramètres¶

ref date / time / timestamp / string

Date, heure ou timestamp de référence. La valeur de référence peut également être fournie sous forme de string. La méthode se charge de la convertir dans le type approprié.

La valeur de sortie reprend le type correspondant à la valeur de référence.

amount number

Nombre d'années/mois/jours/heures/minutes/secondes/millisecondes à ajouter (valeur positive) ou retrancher (valeur négative)

La méthode attend une valeur entière. Si le paramètre est une valeur flottante, la méthode se charge de l'arrondir à l'entier le plus proche.

unit string

Unité de amount. Les unités reconnues sont:

y ou year
m ou month
d ou day
h ou hour
min ou minute
sec ou second
ms ou millisecond
microsecond
n ou nanosecond

La valeur de retour est adaptée pour retourner une date/heure valide. Des exemples illustrant cela sont fournis plus bas.

Retour¶

Nouvel objet du même type que ref contenant la nouvelle date, la nouvelle heure ou le nouveau timestamp résultat de l'addition.

Retourne null si l'un des paramètres n'est pas valide.

Exemple¶

$cal.add( $cal.date(), 15, "day" );

$cal.add("2025-04-01", -1, "month"); // -> 2025-03-01
$cal.add("2025-03-31", -1, "month"); // -> 2025-02-28
$cal.add("2025-03-30", -1, "month"); // -> 2025-02-28
$cal.add("2025-03-29", -1, "month"); // -> 2025-02-28
$cal.add("2025-03-28", -1, "month"); // -> 2025-02-28
$cal.add("2025-03-27", -1, "month"); // -> 2025-02-27

$logger.info(typeof $cal.add("2025-04-01", -1, "month")) // -> date

$cal.add¶