Collator

t

RESCRIPT

type t

usage

RESCRIPT

type usage = [#search | #sort]

sensitivity

RESCRIPT

type sensitivity = [#accent | #base | #case | #variant]

caseFirst

RESCRIPT

type caseFirst = [#"false" | #lower | #upper]

options

RESCRIPT

type options = {
  localeMatcher?: Intl_Common.localeMatcher,
  usage?: usage,
  sensitivity?: sensitivity,
  ignorePunctuation?: bool,
  numeric?: bool,
  caseFirst?: caseFirst,
}

resolvedOptions

RESCRIPT

type resolvedOptions = {
  locale: string,
  usage: usage,
  sensitivity: sensitivity,
  ignorePunctuation: bool,
  collation: [
    | #compat
    | #default
    | #dict
    | #emoji
    | #eor
    | #phonebk
    | #phonetic
    | #pinyin
    | #stroke
    | #trad
    | #unihan
    | #zhuyin
  ],
  numeric?: bool,
  caseFirst?: caseFirst,
}

supportedLocalesOptions

RESCRIPT

type supportedLocalesOptions = {
  localeMatcher: Intl_Common.localeMatcher,
}

make

RESCRIPT

let make: (~locales: array<string>=?, ~options: options=?) => t

Creates a new Intl.Collator instance that can compare strings using locale-aware rules.

See Intl.Collator on MDN.

Examples

RESCRIPT
let collator = Intl.Collator.make(~locales=["en"])
collator->Intl.Collator.compare("apple", "banana") < 0

supportedLocalesOf

RESCRIPT

let supportedLocalesOf: (
  array<string>,
  ~options: supportedLocalesOptions=?,
) => array<string>

supportedLocalesOf(locales, ~options) filters locales to those supported by the runtime for collation.

See Intl.Collator.supportedLocalesOf on MDN.

Examples

RESCRIPT
Intl.Collator.supportedLocalesOf(["en-US", "klingon"]) == ["en-US"]

resolvedOptions

RESCRIPT

let resolvedOptions: t => resolvedOptions

resolvedOptions(collator) returns the locale and collation settings in use.

See Intl.Collator.prototype.resolvedOptions on MDN.

Examples

RESCRIPT
let collator = Intl.Collator.make(~locales=["en-US"])
Intl.Collator.resolvedOptions(collator).locale == "en-US"

compare

RESCRIPT

let compare: (t, string, string) => int

compare(collator, a, b) compares two strings using the rules of collator. Returns a negative number when a comes before b, 0 when equal, and a positive number otherwise.

Examples

RESCRIPT
let collator = Intl.Collator.make(~locales=["en-US"])
collator->Intl.Collator.compare("apple", "banana") < 0

ignore

RESCRIPT

let ignore: t => unit

ignore(collator) ignores the provided collator and returns unit.

This helper is useful when you want to discard a value (for example, the result of an operation with side effects) without having to store or process it further.