Skip to main content

Class: DurationFormatter

@sapphire/duration.DurationFormatter

Display the duration

Param

The duration in milliseconds to parse and display

Param

The language assets

Constructors

constructor

new DurationFormatter(units?): DurationFormatter

Parameters

NameTypeDefault value
unitsDurationFormatAssetsTimeDEFAULT_UNITS

Returns

DurationFormatter

Defined in

lib/DurationFormatter.ts:23

Properties

units

units: DurationFormatAssetsTime = DEFAULT_UNITS

Defined in

lib/DurationFormatter.ts:23

Methods

format

format(duration, precision?, «destructured»?): string

Parameters

NameTypeDefault value
durationnumberundefined
precisionnumber7
«destructured»DurationFormatSeparatorsDEFAULT_SEPARATORS

Returns

string

Defined in

lib/DurationFormatter.ts:25