core/factory - Documentation

Фабричные функции для создания экземпляров OzTime.

Description:

Фабричные функции для создания экземпляров OzTime.

Source:

core/factory.js, line 4

Methods

(static) fromComponents(year, month, day, houropt, minuteopt, secondopt, msopt, timezoneopt, localeopt) → {OzTime}

Description:

Создаёт и возвращает экземпляр OzTime на основе отдельных компонентов даты и времени.

Source:

core/factory.js, line 157

Example

import { fromComponents } from '@alexstukovnikov/oz-time';

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

Parameters:

Name	Type	Attributes	Default	Description
`year`	number			Год.
`month`	number			Месяц от 1 до 12.
`day`	number			День месяца.
`hour`	number	<optional>	`0`	Час от 0 до 23.
`minute`	number	<optional>	`0`	Минута от 0 до 59.
`second`	number	<optional>	`0`	Секунда от 0 до 59.
`ms`	number	<optional>	`0`	Миллисекунда от 0 до 999.
`timezone`	string	<optional>	`'UTC'`	Часовой пояс в формате IANA.
`locale`	string	<optional>	`'en-US'`	Локаль форматирования.

Throws:

Выбрасывается, если любой числовой параметр не является целым числом.

Type

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

Type

RangeError

Returns:

Экземпляр времени.

Type: OzTime

(static) fromDate(date, timezoneopt, localeopt) → {OzTime}

Description:

Создаёт и возвращает экземпляр OzTime на основе объекта Date.

Source:

core/factory.js, line 102

Example

import { fromDate } from '@alexstukovnikov/oz-time';

const time = fromDate(new Date('2024-05-25T12:00:00Z'), 'UTC', 'ru-RU');
console.log(time.toTimestamp()); // ожидаемый результат: 1716638400000

Parameters:

Name	Type	Attributes	Default	Description
`date`	Date			Нативный объект Date.
`timezone`	string	<optional>	`'UTC'`	Часовой пояс в формате IANA.
`locale`	string	<optional>	`'en-US'`	Локаль форматирования.

Throws:

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

Returns:

Экземпляр времени.

Type: OzTime

(static) fromISO(isoString, timezoneopt, localeopt) → {OzTime}

Description:

Создаёт и возвращает экземпляр OzTime на основе ISO-строки.

Source:

core/factory.js, line 122

Example

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

const time = fromISO('2024-05-25T12:00:00Z', 'UTC', 'ru-RU');
console.log(time.format('DD.MM.YYYY HH:mm')); // ожидаемый результат: 25.05.2024 12:00

Parameters:

Name	Type	Attributes	Default	Description
`isoString`	string			Строка даты и времени в формате ISO 8601.
`timezone`	string	<optional>	`'UTC'`	Часовой пояс в формате IANA.
`locale`	string	<optional>	`'en-US'`	Локаль форматирования.

Throws:

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

Type

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

Type

Error

Returns:

Экземпляр времени.

Type: OzTime

(static) fromTimestamp(timestamp, timezoneopt, localeopt) → {OzTime}

Description:

Создаёт и возвращает экземпляр OzTime на основе Unix timestamp.

Source:

core/factory.js, line 83

Example

import { fromTimestamp } from '@alexstukovnikov/oz-time';

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

Parameters:

Name	Type	Attributes	Default	Description
`timestamp`	number			Unix timestamp в миллисекундах.
`timezone`	string	<optional>	`'UTC'`	Часовой пояс в формате IANA.
`locale`	string	<optional>	`'en-US'`	Локаль форматирования.

Throws:

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

Returns:

Экземпляр времени.

Type: OzTime

(static) now(timezoneopt, localeopt) → {OzTime}

Description:

Создаёт и возвращает экземпляр OzTime для текущего момента времени.

Source:

core/factory.js, line 65

Example

import { now } from '@alexstukovnikov/oz-time';

const current = now('Europe/Moscow', 'ru-RU');
console.log(current.getTimezone()); // ожидаемый результат: Europe/Moscow

Parameters:

Name	Type	Attributes	Default	Description
`timezone`	string	<optional>	`'UTC'`	Часовой пояс в формате IANA.
`locale`	string	<optional>	`'en-US'`	Локаль форматирования.

Returns:

Экземпляр с текущим временем.

Type: OzTime