Duration - Documentation

Constructor

new Duration(milliseconds)

Description:

Создаёт экземпляр Duration.

Source:

modules/duration.js, line 33

Example

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

const duration = new Duration(3600000);
console.log(duration.asHours()); // ожидаемый результат: 1

Parameters:

Name	Type	Description
`milliseconds`	number	Длительность в миллисекундах.

Throws:

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

Methods

add(other) → {Duration}

Description:

Возвращает новую длительность, равную сумме текущей и переданной длительности.

Source:

modules/duration.js, line 131

Example

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

const a = duration(1, 'second');
const b = duration(2, 'second');
console.log(a.add(b).asMilliseconds()); // ожидаемый результат: 3000

Parameters:

Name	Type	Description
`other`	Duration	Вторая длительность.

Throws:

Выбрасывается, если other не является экземпляром Duration.
Type TypeError

Returns:

Новая длительность, равная сумме двух значений.

Type: Duration

asDays() → {number}

Description:

Возвращает длительность в днях.

Source:

modules/duration.js, line 114

Example

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

const value = duration(120, 'hour');
console.log(value.asDays()); // ожидаемый результат: 5

Returns:

Длительность в днях.

Type: number

asHours() → {number}

Description:

Возвращает длительность в часах.

Source:

modules/duration.js, line 100

Example

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

const value = duration(36000000, 'millisecond');
console.log(value.asHours()); // ожидаемый результат: 10

Returns:

Длительность в часах.

Type: number

asMilliseconds() → {number}

Description:

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

Source:

modules/duration.js, line 58

Example

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

const value = duration(3600000, 'millisecond');
console.log(value.asMilliseconds()); // ожидаемый результат: 3600000

Returns:

Длительность в миллисекундах.

Type: number

asMinutes() → {number}

Description:

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

Source:

modules/duration.js, line 86

Example

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

const value = duration(3600000, 'millisecond');
console.log(value.asMinutes()); // ожидаемый результат: 60

Returns:

Длительность в минутах.

Type: number

asSeconds() → {number}

Description:

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

Source:

modules/duration.js, line 72

Example

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

const value = duration(3600000, 'millisecond');
console.log(value.asSeconds()); // ожидаемый результат: 3600

Returns:

Длительность в секундах.

Type: number