Temporal.Duration : méthode total()

Syntaxe

total(unit)
total(options)

Paramètres

unit

Une chaîne de caractères représentant l'option unit. Il s'agit d'une surcharge pratique, donc total(unit) est équivalent à total({ unit }), où unit est une chaîne de caractères.

options

Un objet contenant certaines ou toutes les propriétés suivantes (dans l'ordre où elles sont récupérées et validées) :

relativeTo Facultatif

Un fuseau horaire ou une date(heure) normale qui fournit les informations de temps et de calendrier pour résoudre les durées de calendrier (voir le lien pour l'interprétation générale de cette option). Requis si this ou other est une durée de calendrier, ou si unit est une unité de calendrier.

unit

L'une des unités temporelles : "years", "months", "weeks", "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds", ou leurs formes singulières.

Valeur de retour

Un nombre à virgule flottante représentant la durée totale dans l'unité donnée. Peut être inexact en raison des limites de précision des nombres à virgule flottante.

Exceptions

RangeError

Levée dans l'un des cas suivants :

• unit n'est pas fourni ou n'est pas une unité valide.
• this ou other est une durée de calendrier, ou unit est une unité de calendrier, et relativeTo n'est pas fourni.

Description

Si un relativeTo est fourni, le résultat est calculé en ajoutant la durée au point de départ, en trouvant la différence entre le résultat et le point de départ (en nanosecondes), puis en convertissant la différence en l'unité demandée en divisant par le nombre approprié de nanosecondes par unité. Fournir une date-heure zonée permet également de prendre en compte l'heure d'été et d'autres changements de fuseau horaire ; sinon, des jours de 24 heures sont supposés.

Si relativeTo n'est pas fourni, le résultat est calculé en convertissant la durée en nanosecondes et en divisant par le nombre approprié de nanosecondes par unité.

Exemples

Utiliser la méthode total()

const d = Temporal.Duration.from({ hours: 1, minutes: 30 });

console.log(d.total("minutes")); // 90
console.log(d.total("hours")); // 1.5

Total d'une durée de calendrier

const d = Temporal.Duration.from({ months: 1 });

console.log(
  d.total({ unit: "days", relativeTo: Temporal.PlainDate.from("2021-01-01") }),
); // 31

Spécifications

Compatibilité des navigateurs

Voir aussi

• L'objet Temporal.Duration
• La méthode Temporal.Duration.prototype.round()