Utility FunctionsLocales
isSupersetLocale
API Reference for the isSupersetLocale function
Overview
The isSupersetLocale function checks if one locale is a superset of another in the BCP-47 hierarchy without requiring a GT class instance.
Reference
Parameters
Prop
Type
Returns
boolean - true if superLocale is a superset of subLocale
Examples
import { isSupersetLocale } from 'generaltranslation';
// Base language is superset of regional variant
console.log(isSupersetLocale('en', 'en-US')); // true
console.log(isSupersetLocale('es', 'es-ES')); // true
// Regional variant is NOT superset of base language
console.log(isSupersetLocale('en-US', 'en')); // false
// Same locales are supersets of themselves
console.log(isSupersetLocale('en-US', 'en-US')); // trueNotes
- Uses BCP-47 locale hierarchy
- Base languages are supersets of regional variants
- A locale is always a superset of itself
- Essential for building fallback systems
Next Steps
- Use GT class method
isSupersetLocale - Compare languages with
isSameLanguage
How is this guide?