Stage: 3
Champion: Younies Mahmoud, Ujjwal Sharma
Authors: Younies Mahmoud, Ujjwal Sharma
Stage 3 Reviewers
Resources
new Intl.DurationFormat("fr-FR", { style: "long" }).format({
hours: 1,
minutes: 46,
seconds: 40,
});
// => "1 heure, 46 minutes et 40 secondes"In this section, we are going to illustrate each user needs (requirements) and a design for each need (requirement)
Temporal.Duration , which contains:
1000 seconds , how could the user pass the value to the formatting function.new DurationFormat().format({hours: 3, minutes: 4});Users want to determine several types of the formatting width as following
| Format width | Example |
|---|---|
| Long | 1 hour and 50 minutes |
| Short | 1 hr, 50 min |
| Narrow | 1h 50m |
| Digital | 1:50:00 |
style and the value of this parameter may be one of the following strings:
"long""short""narrow""digital"{ years: "long", months: "short", days: "narrow" }.DurationFormat does not do any arithmetic operations nor rounding on the input implicitly.
Instead, the user must edit the input to ensure the input is within the desired range.
To avoid accidentally omitting part of the duration, DurationFormat always outputs all nonzero fields (except sub-second fields truncated by fractionalDigits).
Callers who want to omit nonzero fields (for example, only showing the date or time portion of the duration) should edit the input duration.
const duration = { hours: 1, minutes: 2, seconds: 33 };In most cases, users want to avoid displaying zero-value fields. All zero-valued fields are hidden by default. If you specify the style for a specific field, then it is always displayed, but you can override that behavior by also setting the display option for that particular field to "auto" again explicitly.
For each field foo, there is an option fooDisplay that is set to "auto" by default. Setting that option to "always" causes that field to be displayed even if it is zero; for example, to always show the "day" field, set { dayDisplay: "always" }. If you specify the style for that field by setting the foo option, then the default for fooDisplay becomes "always"; for example, { day: "short" } implies { day: "short", dayDisplay: "always" }.
Adding the locale in string format as a first argument, or specifying a ranked list of locales as an array of string values.
Sometimes it is desirable to display the smallest sub-second unit not by itself but as a fraction of the immediately larger unit.
We allow users to specify a fractionalDigits option that will display the smallest sub-second unit with display set to "auto" as a fraction of the previous unit if it is non-zero and if these values have style set to "numeric". The number of digits used will be the value passed to this option. By default fractionalDigits is undefined. In this case, exactly as many fractional digits as needed to display the whole duration are included. If rounding is necessary, we round toward 0.
const duration = { seconds: 12, milliseconds: 345, microseconds: 600 } ;
new Intl.DurationFormat('en', { style: "digital", fractionalDigits: 2 }).format(duration);
// "0:00:12.35"
new Intl.DurationFormat('en', { seconds: "numeric", fractionalDigits: 2 }).format(duration);
// "12.35"
> new Intl.DurationFormat('en', { seconds: "numeric", fractionalDigits: 5 }).format(duration);
// "12.34560"
> new Intl.DurationFormat('en', { seconds: "numeric"}).format(duration);
// "12.3456"
new Intl.DurationFormat(locales, options)locales: Array<string> | string: A locale string or a list of locale strings in decreasing order of preference.options?: object: An object for configuring the behavior of the instance. It may have some or all of the following properties:
localeMatcher: "best fit" | "lookup": A string denoting which locale matching algorithm to use. Defaults to "best fit".numberingSystem: string: A string containing the name of the numbering system to be used for number formatting.style: "long" | "short" | "narrow" | "digital": The base style to be used for formatting. This can be overriden per-unit by setting the more granular options. Defaults to "short".years: "long" | "short" | "narrow": The style to be used for formatting years.yearsDisplay: "always" | "auto": Whether to always display years, or only if nonzero.months: "long" | "short" | "narrow": The style to be used for formatting months.monthsDisplay: "always" | "auto": Whether to always display months, or only if nonzero.weeks: "long" | "short" | "narrow": The style to be used for formatting weeks.weeksDisplay: "always" | "auto": Whether to always display weeks, or only if nonzero.days: "long" | "short" | "narrow": The style to be used for formatting days.daysDisplay: "always" | "auto": Whether to always display days, or only if nonzero.hours: "long" | "short" | "narrow" | "numeric" | "2-digit": The style to be used for formatting hours.hoursDisplay: "always" | "auto": Whether to always display hours, or only if nonzero.minutes: "long" | "short" | "narrow" | "numeric" | "2-digit": The style to be used for formatting minutes.minutesDisplay: "always" | "auto": Whether to always display minutes, or only if nonzero.seconds: "long" | "short" | "narrow" | "numeric" | "2-digit": The style to be used for formatting seconds.secondsDisplay: "always" | "auto": Whether to always display seconds, or only if nonzero.milliseconds: "long" | "short" | "narrow" | "numeric": The style to be used for formatting milliseconds.millisecondsDisplay: "always" | "auto": Whether to always display milliseconds, or only if nonzero.microseconds: "long" | "short" | "narrow" | "numeric": The style to be used for formatting microseconds.microsecondsDisplay: "always" | "auto": Whether to always display microseconds, or only if nonzero.nanoseconds: "long" | "short" | "narrow" | "numeric": The style to be used for formatting nanoseconds.nanosecondsDisplay: "always" | "auto": Whether to always display nanoseconds, or only if nonzero.fractionalDigits: number: How many fractional digits to display in the output.
Additional decimal places will be truncated towards zero.
(Temporal.Duration.prototype.round can be used to obtain different rounding behavior.)
Normally this option applies to fractional seconds, but this option actually applies to the largest seconds-or-smaller unit that uses the "numeric" or "2-digit" style.
For example, if options are { seconds: "narrow", milliseconds: "numeric", fractionalDigits: 4} then the output is "12.3456 seconds".
If this option is omitted, only nonzero decimals will be displayed and trailing zeroes will be omitted.style for all styles except "digital", for which units years till days default to "short" and hours till nanoseconds default to "numeric".style is undefined, all values default to "short""auto" if the corresponding style option is undefined and "always" otherwise."long" and "short" or between "narrow" and "short". Others may use different representations for each one, e.g. "3 seconds", "3 secs", "3s"."numeric" preceded by a unit of style "numeric" or "2-digit" should act like the style "2-digit" was used instead. For example, {hours: 'numeric', minutes: 'numeric'} can produce output like "3:08".Intl.DurationFormat#formatnew Intl.DurationFormat('en').format(duration)duration (Temporal.Duration | string | object): The duration to be formatted. This could either be a Temporal.Duration object or a string or options bag that can be converted into one.A string containing the formatted duration.
Intl.DurationFormat#formatToPartsnew Intl.DurationFormat('en').formatToParts(duration)duration (Temporal.Duration | string | object): The duration to be formatted. This could either be a Temporal.Duration object or a string or options bag that can be converted into one.An Array<{type: string, value: string}> containing the formatted duration in parts.
Three v8 prototypes (try to use two different possible ICU classes) were made, ALL are: