Temporal.Duration.prototype.total()

Метод total() экземпляров Temporal.Duration возвращает число, представляющее общую длительность в указанной единице измерения.

Синтаксис

total(unit)
total(options)

Параметры

unit

Строка, представляющая опцию unit. Это удобная перегрузка, поэтому total(unit) эквивалентно total({ unit }), где unit — это строка.

options

Объект, содержащий некоторые или все из следующих свойств (в порядке их извлечения и проверки):

relativeTo Необязательно

Дата/время с зоной или без, которая предоставляет информацию о времени и календаре для разрешения календарных длительностей (см. ссылку для общего толкования этой опции). Требуется, если this или other является календарной длительностью, или unit является календарной единицей.

unit

Любая из временных единиц: "years", "months", "weeks", "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds", или их единственные формы.

Возвращаемое значение

Число с плавающей запятой, представляющее общую длительность в указанной единице измерения. Может быть неточным из-за ограничений точности чисел с плавающей запятой.

Исключения

RangeError

Выбрасывается в одном из следующих случаев:

• unit не предоставлена или не является действительной единицей измерения.
• Либо this, либо other является календарной длительностью, или unit является календарной единицей, и relativeTo не предоставлена.

Описание

Если предоставлено relativeTo, результат вычисляется путем добавления длительности к начальной точке, нахождения разницы между результатом и начальной точкой (в наносекундах), а затем преобразования разницы в запрошенную единицу путем деления на соответствующее число наносекунд на единицу. Предоставление даты/времени с зоной позволяет учитывать переход на летнее время и другие изменения часового пояса; в противном случае предполагаются 24-часовые сутки.

Если relativeTo не предоставлена, результат вычисляется путем преобразования длительности в наносекунды и деления на соответствующее число наносекунд на единицу.

Примеры

Использование total()

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

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

Общая длительность календарной длительности

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

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

Спецификации

Совместимость с браузерами

Смотрите также

• Temporal.Duration
• Temporal.Duration.prototype.round()