Module

JS.Intl.Collator

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

Language-sensitive string comparison (e.g. for sorting). See ECMA-402 §10 Collator Objects and MDN Intl.Collator.

#Collator Source

data Collator

An object that compares strings according to a locale and collation options.

#CollatorOptions Source

type CollatorOptions :: Row Typetype CollatorOptions = (caseFirst :: String, collation :: String, ignorePunctuation :: Boolean, localeMatcher :: String, numeric :: Boolean, sensitivity :: String, usage :: String)

#ToCollatorOptions Source

data ToCollatorOptions

Instances

ConvertOption ToCollatorOptions "localeMatcher" LocaleMatcher String
ConvertOption ToCollatorOptions "localeMatcher" String String
ConvertOption ToCollatorOptions "usage" Usage String
ConvertOption ToCollatorOptions "usage" String String
ConvertOption ToCollatorOptions "sensitivity" Sensitivity String
ConvertOption ToCollatorOptions "sensitivity" String String
ConvertOption ToCollatorOptions "caseFirst" CaseFirst String
ConvertOption ToCollatorOptions "caseFirst" String String
ConvertOption ToCollatorOptions "collation" Collation String
ConvertOption ToCollatorOptions "collation" String String
ConvertOption ToCollatorOptions "numeric" Boolean Boolean
ConvertOption ToCollatorOptions "ignorePunctuation" Boolean Boolean

#new Source

new :: forall provided. ConvertOptionsWithDefaults ToCollatorOptions (Record CollatorOptions) (Record provided) (Record CollatorOptions) => Array Locale -> Record provided -> Effect Collator

#new_ Source

new_ :: Array Locale -> Effect Collator

#supportedLocalesOf Source

supportedLocalesOf :: forall provided. ConvertOptionsWithDefaults ToCollatorOptions (Record CollatorOptions) (Record provided) (Record CollatorOptions) => Array Locale -> Record provided -> Array String

#supportedLocalesOf_ Source

supportedLocalesOf_ :: Array Locale -> Array String

#compare Source

compare :: Collator -> String -> String -> Ordering

Compare two strings according to the sort order of the Collator

#resolvedOptions Source

resolvedOptions :: Collator -> Effect ResolvedOptions

#convertOptionsWithDefaults Source

convertOptionsWithDefaults :: forall provided all. ConvertOptionsWithDefaults ToCollatorOptions (Record CollatorOptions) 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