Constructor
constructor(duration: DurationResolvable)
duration
DurationResolvable
required
The duration value in milliseconds. Can be a number or another HolyDuration instance.
Instance Methods
add()
add(duration: HolyDuration): this
add(amount: number, unit?: HumanUnit): this
A HolyDuration instance to add
The amount to add (when using number overload)
unit
HumanUnit
default:"'milliseconds'"
The unit of time (when using number overload)
This instance for chaining
duration.add(5, 'minutes')
duration.add(otherDuration)
subtract()
subtract(duration: HolyDuration): this
subtract(amount: number, unit?: HumanUnit): this
A HolyDuration instance to subtract
The amount to subtract (when using number overload)
unit
HumanUnit
default:"'milliseconds'"
The unit of time (when using number overload)
This instance for chaining
duration.subtract(30, 'seconds')
duration.subtract(otherDuration)
in()
in(unit: HumanUnit): number
The unit to convert to (‘milliseconds’, ‘seconds’, ‘minutes’, ‘hours’, ‘days’, ‘weeks’, ‘months’, ‘years’)
The duration value in the specified unit
const duration = new HolyDuration(60000)
duration.in('seconds') // 60
duration.in('minutes') // 1
format(
type: 'short' | 'long' = 'short',
allowedSegments: Partial<Record<HumanUnit, boolean>> = { /* all units enabled */ }
): string
type
'short' | 'long'
default:"'short'"
Format type:
'short': Compact format (e.g., “1h 30m 45s”)'long': Verbose format (e.g., “1 hour, 30 minutes and 45 seconds”)
allowedSegments
Partial<Record<HumanUnit, boolean>>
Object specifying which time units to include in the output. By default, all units are enabled.
Formatted duration string
const duration = new HolyDuration(5430000) // 1h 30m 30s
// Short format (default)
duration.format('short') // "1h 30m 30s"
// Long format
duration.format('long') // "1 hour, 30 minutes and 30 seconds"
// Only show hours and minutes
duration.format('short', { hours: true, minutes: true, seconds: false })
// "1h 30m"
clone()
Creates a copy of this HolyDuration instance.
New HolyDuration instance with the same duration value
const original = new HolyDuration(1000)
const copy = original.clone()
copy.add(500)
// original remains 1000ms