(that: string, locales?: Array<string>, options?: Intl.CollatorOptions): (
self: string
) => Ordering.OrderingComputes locale-aware ordering for two strings, with optional locales and
collator options, and returns the result as an Ordering (-1, 0, or
1).
Example (Comparing strings by locale)
import { pipe, String } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(pipe("a", String.localeCompare("b")), -1)
assert.deepStrictEqual(pipe("b", String.localeCompare("a")), 1)
assert.deepStrictEqual(pipe("a", String.localeCompare("a")), 0)comparing
Source effect/String.ts:6813 lines
export const const localeCompare: (
that: string,
locales?: Array<string>,
options?: Intl.CollatorOptions
) => (self: string) => Ordering.Ordering
Computes locale-aware ordering for two strings, with optional locales and
collator options, and returns the result as an Ordering (-1, 0, or
1).
Example (Comparing strings by locale)
import { pipe, String } from "effect"
import * as assert from "node:assert"
assert.deepStrictEqual(pipe("a", String.localeCompare("b")), -1)
assert.deepStrictEqual(pipe("b", String.localeCompare("a")), 1)
assert.deepStrictEqual(pipe("a", String.localeCompare("a")), 0)
localeCompare =
(that: stringthat: string, locales: string[] | undefinedlocales?: interface Array<T>Array<string>, options: Intl.CollatorOptions | undefinedoptions?: Intl.interface Intl.CollatorOptionsCollatorOptions) => (self: stringself: string): import OrderingOrdering.type Ordering.Ordering = /*unresolved*/ anyOrdering =>
import numbernumber.sign(self: stringself.String.localeCompare(that: string, locales?: Intl.LocalesArgument, options?: Intl.CollatorOptions): number (+2 overloads)Determines whether two strings are equivalent in the current or specified locale.
localeCompare(that: stringthat, locales: string[] | undefinedlocales, options: Intl.CollatorOptions | undefinedoptions))