Class Duration

Adds another duration to this duration.

Example

const duration1 = Duration.hours(12);
const duration2 = Duration.minutes(30);
const sum = duration1.add(duration2);
console.log(sum.toMinutes());
// Output: 750
Copy

Compares this duration with another duration.

Example

const duration1 = Duration.days(1);
const duration2 = Duration.hours(24);
console.log(duration1.compareTo(duration2)); // Output: 0
Copy

Divides this duration by a scalar divisor.

Throws

Thrown if the divisor is zero.

Example

const duration = Duration.hours(1);
const divided = duration.divide(2);
console.log(divided.toMinutes());
// Output: 30
Copy

Checks if this duration is equal to another duration.

Example

const duration1 = Duration.hours(5);
const duration2 = Duration.hours(5);
console.log(duration1.equals(duration2)); // Output: true
Copy

Checks if this duration is greater than another duration.

Converts the duration to days.

Example

const duration = Duration.hours(48);
const days = duration.inWholeDays();
console.log(days);
// Output: 2
Copy

Converts the duration to hours.

Example

const duration = Duration.days(1);
const hours = duration.inWholeHours();
console.log(hours);
// Output: 24
Copy

Converts the duration to minutes.

Example

const duration = Duration.hours(2);
const minutes = duration.inWholeMinutes();
console.log(minutes);
// Output: 120
Copy

Converts the duration to seconds.

Example

const duration = Duration.minutes(2);
const seconds = duration.inWholeSeconds();
console.log(seconds);
// Output: 120
Copy

Checks if this duration is less than another duration.

Example

const duration1 = Duration.seconds(10);
const duration2 = Duration.seconds(20);

console.log(duration1.lessThan(duration2)); // Output: true
Copy

Multiplies this duration by a scalar factor.

Example

const duration = Duration.minutes(10);
const multiplied = duration.multiply(2);
console.log(multiplied.toMinutes());
// Output: 20
Copy

Splits this duration into days, hours, minutes, seconds, and nanoseconds and executes the given action with these components. The result of the action is returned.

Example

const duration = Duration.seconds(3600);
const result = duration.runIt((days, hours, minutes, seconds, nanoseconds) => {
    return `${days}d ${hours}h ${minutes}m ${seconds}s ${nanoseconds}ns`;
});
console.log(result);
// Output: 0d 1h 0m 0s 0ns
Copy

Subtracts another duration from this duration.

Example

const duration1 = Duration.hours(12);
const duration2 = Duration.minutes(30);
const difference = duration1.subtract(duration2);
console.log(difference.toMinutes());
// Output: 630
Copy

Splits this duration into days, hours, minutes, seconds, and nanoseconds.

Example

const duration = Duration.days(2).add(Duration.hours(12));
const components = duration.toComponents();
console.log(components);
// Output: { days: 2, hours: 12, minutes: 0, seconds: 0, nanoseconds: 0 }
Copy

Converts the duration to an object with properties for each time unit.

Example

const duration = Duration.seconds(123);
const durationObject = duration.toObject();
console.log(durationObject);
// Output: { nanoseconds: 123000000000, microseconds: 123000000, milliseconds: 123000, seconds: 123, minutes: 2, hours: 0, days: 0 }
Copy

Formats the duration as a string.

Example

const duration = Duration.days(1).add(Duration.hours(6));
const formattedString = duration.toString();
console.log(formattedString);
// Output: 1d 6h 0m 0s 0ns
Copy

Creates a Duration object from a duration in days.

Example

const duration = Duration.days(7);
Copy

Creates a Duration object from a duration in hours.

Example

const duration = Duration.hours(24);
Copy

Creates a Duration object from a duration in microseconds.

Example

const duration = Duration.microseconds(5000000);
Copy

Creates a Duration object from a duration in milliseconds.

Example

const duration = Duration.milliseconds(5000);
Copy

Creates a Duration object from a duration in minutes.

Example

const duration = Duration.minutes(60);
Copy

Creates a Duration object from a duration in nanoseconds.

Example

const duration = Duration.nanoseconds(1e9);
Copy

Creates a Duration object from a duration in seconds.

Example

const duration = Duration.seconds(60);
Copy