JS.Intl.DurationFormat

data DurationFormat

An object that formats durations (years, months, ..., nanoseconds) by locale.

type DurationFormatOptions :: Row Typetype DurationFormatOptions = (days :: String, daysDisplay :: String, fractionalDigits :: Int, hours :: String, hoursDisplay :: String, localeMatcher :: String, microseconds :: String, microsecondsDisplay :: String, milliseconds :: String, millisecondsDisplay :: String, minutes :: String, minutesDisplay :: String, months :: String, monthsDisplay :: String, nanoseconds :: String, nanosecondsDisplay :: String, numberingSystem :: String, seconds :: String, secondsDisplay :: String, style :: String, weeks :: String, weeksDisplay :: String, years :: String, yearsDisplay :: String)

Options to pass to the DurationFormat constructor (new or new_)

Note: Not all combinations of options are valid. See the specification (https://tc39.es/proposal-intl-duration-format/#durationformat-objects) or the MDN reference (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DurationFormat/DurationFormat)

data ToDurationFormatOptions

Instances

• ConvertOption ToDurationFormatOptions "localeMatcher" LocaleMatcher String
• ConvertOption ToDurationFormatOptions "localeMatcher" String String
• ConvertOption ToDurationFormatOptions "numberingSystem" String String
• ConvertOption ToDurationFormatOptions "style" DurationFormatStyle String
• ConvertOption ToDurationFormatOptions "style" String String
• ConvertOption ToDurationFormatOptions "years" Years String
• ConvertOption ToDurationFormatOptions "years" String String
• ConvertOption ToDurationFormatOptions "yearsDisplay" YearsDisplay String
• ConvertOption ToDurationFormatOptions "yearsDisplay" String String
• ConvertOption ToDurationFormatOptions "months" Months String
• ConvertOption ToDurationFormatOptions "months" String String
• ConvertOption ToDurationFormatOptions "monthsDisplay" MonthsDisplay String
• ConvertOption ToDurationFormatOptions "monthsDisplay" String String
• ConvertOption ToDurationFormatOptions "weeks" Weeks String
• ConvertOption ToDurationFormatOptions "weeks" String String
• ConvertOption ToDurationFormatOptions "weeksDisplay" WeeksDisplay String
• ConvertOption ToDurationFormatOptions "weeksDisplay" String String
• ConvertOption ToDurationFormatOptions "days" Days String
• ConvertOption ToDurationFormatOptions "days" String String
• ConvertOption ToDurationFormatOptions "daysDisplay" DaysDisplay String
• ConvertOption ToDurationFormatOptions "daysDisplay" String String
• ConvertOption ToDurationFormatOptions "hours" Hours String
• ConvertOption ToDurationFormatOptions "hours" String String
• ConvertOption ToDurationFormatOptions "hoursDisplay" HoursDisplay String
• ConvertOption ToDurationFormatOptions "hoursDisplay" String String
• ConvertOption ToDurationFormatOptions "minutes" Minutes String
• ConvertOption ToDurationFormatOptions "minutes" String String
• ConvertOption ToDurationFormatOptions "minutesDisplay" MinutesDisplay String
• ConvertOption ToDurationFormatOptions "minutesDisplay" String String
• ConvertOption ToDurationFormatOptions "seconds" Seconds String
• ConvertOption ToDurationFormatOptions "seconds" String String
• ConvertOption ToDurationFormatOptions "secondsDisplay" SecondsDisplay String
• ConvertOption ToDurationFormatOptions "secondsDisplay" String String
• ConvertOption ToDurationFormatOptions "milliseconds" Milliseconds String
• ConvertOption ToDurationFormatOptions "milliseconds" String String
• ConvertOption ToDurationFormatOptions "millisecondsDisplay" MillisecondsDisplay String
• ConvertOption ToDurationFormatOptions "millisecondsDisplay" String String
• ConvertOption ToDurationFormatOptions "nanoseconds" Nanoseconds String
• ConvertOption ToDurationFormatOptions "nanoseconds" String String
• ConvertOption ToDurationFormatOptions "nanosecondsDisplay" NanosecondsDisplay String
• ConvertOption ToDurationFormatOptions "nanosecondsDisplay" String String
• ConvertOption ToDurationFormatOptions "microseconds" Microseconds String
• ConvertOption ToDurationFormatOptions "microseconds" String String
• ConvertOption ToDurationFormatOptions "microsecondsDisplay" MicrosecondsDisplay String
• ConvertOption ToDurationFormatOptions "microsecondsDisplay" String String
• ConvertOption ToDurationFormatOptions "fractionalDigits" Int Int

class DurationLike a  where

Types that can be converted to a duration object suitable for DurationFormat. Instances are provided for:

• Records with any subset of Duration fields (e.g. { hours :: Number, minutes :: Number })
• Data.Interval.Duration (maps the 7 ISO 8601 components; missing components default to 0.0)
• Data.Time.Duration.Days, Hours, Minutes, Seconds, Milliseconds

Members

• unsafeToDurationForeign :: a -> Foreign

Instances

• DurationLike Duration
• DurationLike Days
• DurationLike Hours
• DurationLike Minutes
• DurationLike Seconds
• DurationLike Milliseconds

new :: forall provided. ConvertOptionsWithDefaults ToDurationFormatOptions (Record DurationFormatOptions) (Record provided) (Record DurationFormatOptions) => Array Locale -> Record provided -> Effect DurationFormat

new_ :: Array Locale -> Effect DurationFormat

supportedLocalesOf :: forall provided. ConvertOptionsWithDefaults ToDurationFormatOptions (Record DurationFormatOptions) (Record provided) (Record DurationFormatOptions) => Array Locale -> Record provided -> Array String

supportedLocalesOf_ :: Array Locale -> Array String

format :: forall duration. DurationLike duration => DurationFormat -> duration -> String

Format a duration

formatToParts :: forall duration. DurationLike duration => DurationFormat -> duration -> Array { type :: String, value :: String }

Allows locale-aware formatting of strings produced by the DurationFormat

resolvedOptions :: DurationFormat -> Effect ResolvedOptions

convertOptionsWithDefaults :: forall provided all. ConvertOptionsWithDefaults ToDurationFormatOptions (Record DurationFormatOptions) provided all => provided -> all