Class Collator

See the Rust documentation for Collator for more information.

Index

Constructors

Accessors

ffiValue resolvedOptions

Methods

Constructors

constructor

new Collator(
    provider: DataProvider,
    locale: Locale,
    options: CollatorOptions_obj,
): Collator
Parameters
- provider: DataProvider
- locale: Locale
- options: CollatorOptions_obj
Returns Collator
- Defined in Collator.d.ts:46

Accessors

ffiValue

get ffiValue(): number
Returns number
- Defined in Collator.d.ts:17

resolvedOptions

get resolvedOptions(): CollatorResolvedOptions
The resolved options showing how the default options, the requested options, and the options from locale data were combined. None of the struct fields will have Auto as the value.

See the Rust documentation for resolved_options for more information.

Returns CollatorResolvedOptions
- Defined in Collator.d.ts:44

Methods

compare

compare(left: string, right: string): number
Compare two strings.

Ill-formed input is treated as if errors had been replaced with REPLACEMENT CHARACTERs according to the WHATWG Encoding Standard.

See the Rust documentation for compare_utf16 for more information.
Parameters
- left: string
- right: string
Returns number
- Defined in Collator.d.ts:35

`Static`create

create(locale: Locale, options: CollatorOptions_obj): Collator
Construct a new Collator instance using compiled data.

See the Rust documentation for try_new for more information.
Parameters
- locale: Locale
- options: CollatorOptions_obj
Returns Collator
- Defined in Collator.d.ts:25