Intl.DurationFormat
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The Intl.DurationFormat object enables language-sensitive duration formatting.
Constructor
Intl.DurationFormat()Experimental-
Creates a new
Intl.DurationFormatobject.
Static methods
Intl.DurationFormat.supportedLocalesOf()Experimental-
Returns an array containing those of the provided locales that are supported without having to fall back to the runtime's default locale.
Instance properties
These properties are defined on Intl.DurationFormat.prototype and shared by all Intl.DurationFormat instances.
Intl.DurationFormat.prototype.constructor-
The constructor function that created the instance object. For
Intl.DurationFormatinstances, the initial value is theIntl.DurationFormatconstructor. Intl.DurationFormat.prototype[@@toStringTag]-
The initial value of the
@@toStringTagproperty is the string"Intl.DurationFormat". This property is used inObject.prototype.toString().
Instance methods
Intl.DurationFormat.prototype.format()Experimental-
Getter function that formats a duration according to the locale and formatting options of this
DurationFormatobject. Intl.DurationFormat.prototype.formatToParts()Experimental-
Returns an
Arrayof objects representing the formatted duration in parts. Intl.DurationFormat.prototype.resolvedOptions()Experimental-
Returns a new object with properties reflecting the locale and formatting options computed during initialization of the object.
Examples
Using Intl.DurationFormat
The examples below show how to use the Intl.DurationFormat object to format a duration object with various locales and styles.
js
const duration = {
hours: 1,
minutes: 46,
seconds: 40,
};
// With style set to "long" and locale "fr-FR"
new Intl.DurationFormat("fr-FR", { style: "long" }).format(duration);
// "1 heure, 46 minutes et 40 secondes"
// With style set to "short" and locale "en"
new Intl.DurationFormat("en", { style: "short" }).format(duration);
// "1 hr, 46 min and 40 sec"
// With style set to "short" and locale "pt"
new Intl.DurationFormat("pt", { style: "narrow" }).format(duration);
// "1h 46min 40s"
Specifications
| Specification |
|---|
| Intl.DurationFormat # durationformat-objects |
Browser compatibility
BCD tables only load in the browser