Skip to content

StringIsEqualOptions

StringIsEqualOptions = object

Defined in: packages/core/src/string/string-is-equal.ts:1

optional caseInsensitive?: boolean

Defined in: packages/core/src/string/string-is-equal.ts:3


optional locale?: string | string[] | null

Defined in: packages/core/src/string/string-is-equal.ts:17

The locale(s) to use for case conversion when caseInsensitive is true.

If not provided, the String.prototype.toLowerCase method is used, which may not handle locale-specific case mappings correctly. If provided, it should be a string or an array of strings representing the locale(s) to use for case conversion.

Note: The locale(s) are only used for case conversion, not for collation. For example, the Turkish locale has special rules for the letter “i”, which may affect the result of a case-insensitive comparison.