utils/units

Утилиты для нормализации и проверки единиц времени.

Description:

  • Утилиты для нормализации и проверки единиц времени.

Source:

Members

(static, constant) CALENDAR_UNITS :Array.<string>

Description:

  • Массив поддерживаемых календарных единиц времени.

Source:

Массив поддерживаемых календарных единиц времени.

Type:
  • Array.<string>

(static, constant) FIXED_UNIT_TO_MS :Object.<string, number>

Description:

  • Точное количество миллисекунд для фиксированных единиц времени.

Source:

Точное количество миллисекунд для фиксированных единиц времени.

Type:
  • Object.<string, number>

(inner, constant) UNIT_ALIASES :Object.<string, string>

Description:

  • Объект соотношений разных названий единиц времени к каноническим названиям.

Source:

Объект соотношений разных названий единиц времени к каноническим названиям.

Type:
  • Object.<string, string>

Methods

(static) isCalendarUnit(unit) → {boolean}

Description:

  • Проверяет, является ли единица календарной.

Source:
Example
import { isCalendarUnit } from './utils/units.js';

console.log(isCalendarUnit('month')); // ожидаемый результат: true
Parameters:
Name Type Description
unit string

Единица времени.
Returns:

true, если единица является календарной.

Type
boolean

(static) isFixedUnit(unit) → {boolean}

Description:

  • Проверяет, является ли единица фиксированной.

Source:
Example
import { isFixedUnit } from './utils/units.js';

console.log(isFixedUnit('minute')); // ожидаемый результат: true
Parameters:
Name Type Description
unit string

Единица времени.
Returns:

true, если единица является фиксированной.

Type
boolean

(static) normalizeUnit(unit) → {string}

Description:

  • Нормализует единицу времени к каноническому виду.

Source:
Example
import { normalizeUnit } from './utils/units.js';

console.log(normalizeUnit('hours')); // ожидаемый результат: hour
Parameters:
Name Type Description
unit string

Единица времени.
Throws:

  • Выбрасывается, если unit пустой или не является строкой.

    Type
    TypeError

  • Выбрасывается, если unit не поддерживается.

    Type
    Error
Returns:

Каноническое название единицы времени.

Type
string

(static) unitToMilliseconds(unit) → {number}

Description:

  • Возвращает точное количество миллисекунд в одной фиксированной единице времени.

Source:
Example
import { unitToMilliseconds } from './utils/units.js';

console.log(unitToMilliseconds('hour')); // ожидаемый результат: 3600000
Parameters:
Name Type Description
unit string

Фиксированная единица времени.
Throws:

Выбрасывается, если unit нельзя точно перевести в миллисекунды.

Type
Error
Returns:

Количество миллисекунд в одной единице времени.

Type
number