Skip to content

Instance MethodFoundationEssentials

isEquivalent(to:)

iOS 16.0+ iPadOS 16.0+ Mac Catalyst 16.0+ macOS 13.0+ tvOS 16.0+ watchOS 9.0+
Returns a Boolean value that indicates whether this language and another language are equivalent after expanding missing components.
func isEquivalent(to language: Locale.Language) -> Bool

Parameters

language

A language to compare equivalence with.

Return Value

true if the two languages are equivalent; false otherwise.

Discussion

The following example shows equivalence tests run on various ways of expressing the US English language, followed by a test against UK English.

let en = Locale.Language(identifier: "en")
let enUS = Locale.Language(identifier: "en-US")
let enLatn = Locale.Language(identifier: "en-Latn")
let enLatnUS = Locale.Language(identifier: "en-Latn-US")

let test1 = en.isEquivalent(to: enUS) // true
let test2 = en.isEquivalent(to: enLatn) // true
let test3 = en.isEquivalent(to: enLatnUS) // true

let enUK = Locale.Language(identifier: "en-UK")
let test4 = en.isEquivalent(to: enUK) // false