TimeDiff

TimeDiff — это TypeScript-библиотека для расчета разницы между двумя датами с поддержкой локализации, правильного форматирования на нескольких языках (включая русскую и английскую локали) и поддержки ISO 8601.

Установка

Установите пакет с помощью npm:

npm install @on_plc/timediff

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

Импортирование библиотеки

import TimeDiff from '@on_plc/timediff';

Примеры использования

Создание объекта TimeDiff

const date1 = new Date(2023, 0, 1, 0, 0, 0); // 1 января 2023 года
const date2 = new Date(2023, 0, 2, 12, 30, 15); // 2 января 2023 года

const timeDiff = new TimeDiff(date1, date2);

Поддержка ISO 8601 и языковых настроек

Можно создать объект TimeDiff из строки ISO 8601 или указать локаль для автоматического выбора языка.

const isoDiff = TimeDiff.fromISO("P1DT12H30M15S");
console.log(isoDiff.humanize('ru', 'long')); // Output: "1 день, 12 часов, 30 минут, 15 секунд"

Форматирование разницы в человекочитаемом формате

• Полный формат (long) — с учетом множественного числа.
• Короткий формат (short) — с сокращенными единицами времени.
• ISO формат (iso) — представление в ISO 8601.

// Английский язык, полный формат
console.log(timeDiff.humanize('en', 'long')); 
// Output: "1 day, 12 hours, 30 minutes, 15 seconds"

// ISO формат
console.log(timeDiff.humanize('', 'iso'));
// Output: "P1DT12H30M15S"

Сложение и вычитание объектов TimeDiff

const date3 = new Date(2023, 0, 3);
const diff1 = new TimeDiff(date1, date2);
const diff2 = new TimeDiff(date2, date3);

const sum = TimeDiff.add(diff1, diff2);
const difference = TimeDiff.subtract(diff1, diff2);

console.log(sum.humanize('en', 'long')); // Форматирование суммы
console.log(difference.humanize('ru', 'short')); // Форматирование разности

API

new TimeDiff(date1: Date, date2: Date)

Создает объект TimeDiff, рассчитывая разницу между двумя датами.

fromISO(isoString: string): TimeDiff

Создает TimeDiff из строки ISO 8601.

humanize(locale?: string, format?: 'short' | 'long' | 'iso'): string

Форматирует разницу во времени в человекочитаемый формат. Формат 'iso' возвращает строку ISO 8601.

valueOf(): number

Возвращает разницу во времени в миллисекундах.

TimeDiff.add(a: TimeDiff, b: TimeDiff): TimeDiff

Складывает две разницы TimeDiff и возвращает новую разницу.

TimeDiff.subtract(a: TimeDiff, b: TimeDiff): TimeDiff

Вычитает одну разницу TimeDiff из другой и возвращает результат.

Участие в разработке

Будем рады вашим предложениям и отзывам! Пожалуйста, создавайте Issues и Pull Requests, чтобы помочь улучшить этот пакет.

Лицензия

MIT License