modules/arithmetic - Documentation

Модуль арифметических операций над экземплярами OzTime.

Description:

Модуль арифметических операций над экземплярами OzTime.

Source:

modules/arithmetic.js, line 5

Methods

(static) add(time, amount, unit) → {OzTime}

Description:

Возвращает новый экземпляр OzTime, у которого timestamp увеличен на указанное количество единиц времени.

Поддерживает как фиксированные, так и календарные единицы времени. Исходный экземпляр не изменяется.

Source:

modules/arithmetic.js, line 59

Example

import { add, fromISO } from '@alexstukovnikov/oz-time';

const time = fromISO('2024-05-25T12:00:00Z', 'UTC', 'ru-RU');
const result = add(time, 2, 'day');
console.log(result.toISOString()); // ожидаемый результат: 2024-05-27T12:00:00.000Z

Parameters:

Name	Type	Description
`time`	OzTime	Исходное значение времени.
`amount`	number	Количество единиц времени.
`unit`	string	Единица времени.

Throws:

Выбрасывается, если time или amount некорректны.
Type TypeError

Returns:

Новый экземпляр OzTime с timestamp, сдвинутым вперёд.

Type: OzTime

(static) subtract(time, amount, unit) → {OzTime}

Description:

Возвращает новый экземпляр OzTime, у которого timestamp уменьшен на указанное количество единиц времени.

Исходный экземпляр не изменяется.

Source:

modules/arithmetic.js, line 95

Example

import { subtract, fromISO } from '@alexstukovnikov/oz-time';

const time = fromISO('2024-05-25T12:00:00Z', 'UTC', 'ru-RU');
const result = subtract(time, 3, 'hour');
console.log(result.toISOString()); // ожидаемый результат: 2024-05-25T09:00:00.000Z

Parameters:

Name	Type	Description
`time`	OzTime	Исходное значение времени.
`amount`	number	Количество единиц времени.
`unit`	string	Единица времени.

Throws:

Выбрасывается, если time или amount некорректны.
Type TypeError

Returns:

Новый экземпляр OzTime с timestamp, сдвинутым назад.

Type: OzTime