locale-enum
v1.2.0
Published
A TypeScript enum of Unicode CLDR locales with backwards-compatible locale identifiers.
Maintainers
Readme
TypeScript Locale Enum
A TypeScript enum of locale identifiers such as en-US and zh-Hant-HK.
Keys use underscores; values use hyphens and preserve locale casing.
1,336 identifiers: 1,121 from Unicode CLDR 48.2 plus 215 legacy identifiers retained from version 1.1.1. All 731 identifiers previously exported by 1.1.1 keep their original keys and values. There are no runtime dependencies.
Install
npm install locale-enumUse
const { Locale, CLDR_VERSION } = require('locale-enum');
console.log(Locale.en_US); // "en-US"
console.log(Locale.pt_BR); // "pt-BR"
console.log(CLDR_VERSION); // "48.2.0"ES modules and TypeScript:
import { Locale } from 'locale-enum';
const locale: Locale = Locale.zh_Hant_HK;
console.log(locale); // "zh-Hant-HK"The enum also provides autocomplete in JavaScript editors. TypeScript declarations
are included; no separate @types package is needed.
Data source and scope
The enum is generated from the stable Unicode CLDR JSON 48.2.0 release:
availableLocales.json, thefulllist.defaultContent.json, which supplies inherited/default-content identifiers such asen-US,de-DEandpt-BR.data/legacy-1.1.1.json, the previous enum, retained for compatibility. Entries outside the two CLDR lists have an explicit legacy comment in the declarations.
This is a finite list of useful locale identifiers, not every possible BCP 47 tag.
BCP 47 also permits extensions and private-use tags. Presence in this enum does not
prove support in a particular runtime, translation service or application. CLDR's
full list also contains locales with different levels of translation coverage.
Legacy values are preserved exactly; they are not automatically canonicalized.
For example, version 1.1.1's en_US_POSIX remains en-US-POSIX for compatibility,
even though it is not in the two CLDR source lists used by this package.
See the Unicode release list for source versions. CLDR 49 was still a beta when this release was prepared on 2026-10-10. Unicode-derived data is distributed under the included Unicode License V3; see NOTICE.
Updating the data
npm ci
npm run generate
npm test
npm packcldr-core is pinned as a development dependency. To update CLDR, change that pin,
regenerate the enum, review the diff, and update the documented counts and version.
Generation sorts keys deterministically and validates identifiers. Tests verify
complete source coverage, legacy compatibility, exports and TypeScript use.
npm run check:data fails if the committed enum differs from the pinned source.
Build and test tooling uses Node.js 18 or newer. The published enum contains no filesystem, network or Node-specific runtime code.
