View source

typedef CollatorOptions

package js.lib.intl

import js.lib.intl.Collator

Available on js

Fields

@:optionaloptionalusage:Null<Usage>

Whether the comparison is for sorting or for searching for matching strings. The default is Sort.

@:optionaloptionalsensitivity:Null<Sensitivity>

Which differences in the strings should lead to non-zero result values. The default is Variant for usage Sort; it's locale dependent for usage Search.

@:optionaloptionalnumeric:Null<Bool>

Whether numeric collation should be used, such that "1" < "2" < "10". The default is false. This option can be set through an options property or through a Unicode extension key; if both are provided, the options property takes precedence. Implementations are not required to support this property.

@:optionaloptionallocaleMatcher:Null<LocaleMatcher>

The locale matching algorithm to use. The default is BestFit. For information about this option, see the Intl page.

@:optionaloptionalignorePunctuation:Null<Bool>

Whether punctuation should be ignored. The default is false.

@:optionaloptionalcaseFirst:Null<String>

Whether upper case or lower case should sort first. The default is "false". This option can be set through an options property or through a Unicode extension key; if both are provided, the options property takes precedence. Implementations are not required to support this property.