Duration - 🧋 boba documentation

class Duration

A representation of a duration of time within a codebase. This class provides a way to work with durations of time in a type-safe manner.

Examples

setTimeout(() => {}, Duration.seconds(1 as Seconds).toMilliseconds());

setTimeout(() => {}, Duration.minutes(1 as Minutes).toMilliseconds());

Converting to milliseconds



days(days: Days): Duration

Creates a Duration from days.



hours(hours: Hours): Duration

Creates a Duration from hours.



milliseconds(milliseconds: Milliseconds): Duration

Creates a Duration from milliseconds.



minutes(minutes: Minutes): Duration

Creates a Duration from minutes.



seconds(seconds: Seconds): Duration

Creates a Duration from seconds.



weeks(weeks: Weeks): Duration

Creates a Duration from weeks.



years(years: Years): Duration

Creates a Duration from years.



sleep(): Promise<void>

Sleeps for the current duration.



toDays(): Days

Converts the duration to days.



toHours(): Hours

Converts the duration to hours.



toMilliseconds(): Milliseconds

Converts the duration to milliseconds.



toMinutes(): Minutes

Converts the duration to minutes.



toSeconds(): Seconds

Converts the duration to seconds.



toWeeks(): Weeks

Converts the duration to weeks.



toYears(): Years

Converts the duration to years.