modules/compare - Documentation

Модуль сравнений для экземпляров OzTime.

Description:

Модуль сравнений для экземпляров OzTime.

Source:

modules/compare.js, line 4

Methods

(static) isAfter(a, b, unitopt) → {boolean}

Description:

Проверяет, находится ли первое значение позже второго с учётом заданной точности.

Source:

modules/compare.js, line 143

Example

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

const a = fromISO('2024-05-26T12:00:00Z');
const b = fromISO('2024-05-25T12:00:00Z');
console.log(isAfter(a, b)); // ожидаемый результат: true

Parameters:

Name	Type	Attributes	Default	Description
`a`	OzTime			Первое значение.
`b`	OzTime			Второе значение.
`unit`	string	<optional>	`'millisecond'`	Точность сравнения.

Throws:

Выбрасывается, если хотя бы один аргумент не является экземпляром OzTime.
Type TypeError

Returns:

true, если первое значение позже второго.

Type: boolean

(static) isBefore(a, b, unitopt) → {boolean}

Description:

Проверяет, находится ли первое значение раньше второго с учётом заданной точности.

Source:

modules/compare.js, line 117

Example

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

const a = fromISO('2024-05-25T12:00:00Z');
const b = fromISO('2024-05-26T12:00:00Z');
console.log(isBefore(a, b)); // ожидаемый результат: true

Parameters:

Name	Type	Attributes	Default	Description
`a`	OzTime			Первое значение.
`b`	OzTime			Второе значение.
`unit`	string	<optional>	`'millisecond'`	Точность сравнения.

Throws:

Выбрасывается, если хотя бы один аргумент не является экземпляром OzTime.
Type TypeError

Returns:

true, если первое значение раньше второго.

Type: boolean

(static) isBetween(target, left, right, unitopt, inclusivityopt) → {boolean}

Description:

Проверяет, попадает ли целевое значение в диапазон между двумя границами с учётом заданной точности.

Source:

modules/compare.js, line 173

Example

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

const target = fromISO('2024-05-25T12:00:00Z');
const start = fromISO('2024-05-25T10:00:00Z');
const end = fromISO('2024-05-25T14:00:00Z');
console.log(isBetween(target, start, end)); // ожидаемый результат: true

Parameters:

Name	Type	Attributes	Default	Description
`target`	OzTime			Проверяемое значение.
`left`	OzTime			Левая граница.
`right`	OzTime			Правая граница.
`unit`	string	<optional>	`'millisecond'`	Точность сравнения.
`inclusivity`	'[]' \| '[)' \| '(]' \| '()'	<optional>	`'[]'`	Формат включённости границ.

Throws:

Выбрасывается, если хотя бы один аргумент не является экземпляром OzTime.

Type

TypeError
Выбрасывается, если inclusivity задан некорректно.

Type

Error

Returns:

true, если значение находится внутри диапазона.

Type: boolean

(static) isSame(a, b, unitopt) → {boolean}

Description:

Проверяет, равны ли два значения времени с учётом заданной точности.

Source:

modules/compare.js, line 91

Example

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

const a = fromISO('2024-05-25T12:00:00.100Z');
const b = fromISO('2024-05-25T12:00:00.900Z');
console.log(isSame(a, b, 'second')); // ожидаемый результат: true

Parameters:

Name	Type	Attributes	Default	Description
`a`	OzTime			Первое значение.
`b`	OzTime			Второе значение.
`unit`	string	<optional>	`'millisecond'`	Точность сравнения.

Throws:

Выбрасывается, если хотя бы один аргумент не является экземпляром OzTime.
Type TypeError

Returns:

true, если значения равны на заданной точности.

Type: boolean