Module

JS.Intl.DurationFormat

Package: purescript-js-intl
Repository: pete-murphy/purescript-js-intl

#DurationFormat Source

data DurationFormat

Language-sensitive duration formatting

#DurationFormatOptions Source

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)

#ToDurationFormatOptions Source

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

#new Source

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

#new_ Source

new_ :: Array Locale -> Effect DurationFormat

#supportedLocalesOf Source

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

#supportedLocalesOf_ Source

supportedLocalesOf_ :: Array Locale -> Array String

#format Source

format :: forall duration r. Union duration r Duration => DurationFormat -> Record duration -> String

Format a duration

#formatToParts Source

formatToParts :: forall duration r. Union duration r Duration => DurationFormat -> Record duration -> Array { type :: String, value :: String }

Allows locale-aware formatting of strings produced by the DurationFormat

#resolvedOptions Source

resolvedOptions :: DurationFormat -> Effect ResolvedOptions

#convertOptionsWithDefaults Source

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

Modules: JS.Intl; JS.Intl.Collator; JS.Intl.DateTimeFormat; JS.Intl.DisplayNames; JS.Intl.DurationFormat; JS.Intl.ListFormat; JS.Intl.Locale; JS.Intl.NumberFormat; JS.Intl.Options.AvailableCanonical; JS.Intl.Options.CaseFirst; JS.Intl.Options.Collation; JS.Intl.Options.CompactDisplay; JS.Intl.Options.CurrencyDisplay; JS.Intl.Options.CurrencySign; JS.Intl.Options.DateStyle; JS.Intl.Options.Day; JS.Intl.Options.DayPeriod; JS.Intl.Options.Days; JS.Intl.Options.DaysDisplay; JS.Intl.Options.DisplayNamesType; JS.Intl.Options.DurationFormatStyle; JS.Intl.Options.Era; JS.Intl.Options.Fallback; JS.Intl.Options.FormatMatcher; JS.Intl.Options.Granularity; JS.Intl.Options.Hour; JS.Intl.Options.HourCycle; JS.Intl.Options.Hours; JS.Intl.Options.HoursDisplay; JS.Intl.Options.Internal.Unsafe; JS.Intl.Options.LanguageDisplay; JS.Intl.Options.ListFormatType; JS.Intl.Options.LocaleMatcher; JS.Intl.Options.Microseconds; JS.Intl.Options.MicrosecondsDisplay; JS.Intl.Options.Milliseconds; JS.Intl.Options.MillisecondsDisplay; JS.Intl.Options.Minute; JS.Intl.Options.Minutes; JS.Intl.Options.MinutesDisplay; JS.Intl.Options.Month; JS.Intl.Options.Months; JS.Intl.Options.MonthsDisplay; JS.Intl.Options.Nanoseconds; JS.Intl.Options.NanosecondsDisplay; JS.Intl.Options.Notation; JS.Intl.Options.NumberFormatStyle; JS.Intl.Options.Numeric; JS.Intl.Options.PluralCategory; JS.Intl.Options.PluralRulesType; JS.Intl.Options.RelativeTimeUnit; JS.Intl.Options.RoundingIncrement; JS.Intl.Options.RoundingMode; JS.Intl.Options.RoundingPriority; JS.Intl.Options.Second; JS.Intl.Options.Seconds; JS.Intl.Options.SecondsDisplay; JS.Intl.Options.Sensitivity; JS.Intl.Options.SignDisplay; JS.Intl.Options.Style; JS.Intl.Options.TimeStyle; JS.Intl.Options.TimeZoneName; JS.Intl.Options.TrailingZeroDisplay; JS.Intl.Options.UnitDisplay; JS.Intl.Options.Usage; JS.Intl.Options.UseGrouping; JS.Intl.Options.Weekday; JS.Intl.Options.Weeks; JS.Intl.Options.WeeksDisplay; JS.Intl.Options.Year; JS.Intl.Options.Years; JS.Intl.Options.YearsDisplay; JS.Intl.PluralRules; JS.Intl.RelativeTimeFormat; JS.Intl.Segmenter; JS.LocaleSensitive.Date; JS.LocaleSensitive.Number; JS.LocaleSensitive.String