Function localeCompare

localeCompare(that): number
Determines whether two strings are equivalent in the current locale.
Parameters
- that: string
  String to compare to target string
Returns number
- Defined in docs/node_modules/typescript/lib/lib.es5.d.ts:450
localeCompare(that, locales?, options?): number
Determines whether two strings are equivalent in the current or specified locale.
Parameters
- that: string
  String to compare to target string
- Optional locales: string | string[]
  A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.
- Optional options: CollatorOptions
  An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.
Returns number
- Defined in docs/node_modules/typescript/lib/lib.es5.d.ts:4522

Generated using TypeDoc