CLDRFramework
Constructs instances of CLDR for a given locale.
new
Constructs an instance of the framework with a set of options.
Syntax
new CLDRFramework(options)
Parameters
options: CLDROptions- Options to configure the framework with a loader
Example
import { CLDRFramework, LocaleMatcher } from '@phensley/cldr';
import pkg from './package.json';
// Get exact version of @phensley/cldr dependency
const version = pkg.dependencies['@phensley/cldr'];
const packurl = `https://cdn.jsdelivr.net/npm/@phensley/cldr@${version}/packs`;
// Fetch the language resource pack for this version.
const asyncLoader = language =>
fetch(`${packurl}/${language}.json`)
.then(r => r.json())
.catch(err => console.log(err));
export const framework = new CLDRFramework({ asyncLoader });
availableLocales
Return an array containing all of the available locales.
Syntax
static availableLocales(): Locale[]
Example
import { CLDRFramework } from '@phensley/cldr';
const locales = CLDRFramework.availableLocales();
for (const locale of locales.slice(0, 10)) {
const { id, tag } = locale;
log(`${tag.language()}-${tag.script()}-${tag.region()} ${id}`);
}
log('...');
af-Latn-ZA af af-Latn-NA af-NA am-Ethi-ET am ar-Arab-EG ar ar-Arab-AE ar-AE ar-Arab-BH ar-BH ar-Arab-DJ ar-DJ ar-Arab-DZ ar-DZ ar-Arab-EG ar-EG ar-Arab-EH ar-EH ...
See Also
get
Uses the synchronous loader to construct a CLDR instance. Note that this will raise an error if no synchronous loader has been configured.
Syntax
framework.get(locale): CLDR
Parameters
locale: string | Locale- An identifier for the locale to use
Example
import { framework } from './framework';
const locale = 'ko-KR';
const cldr = framework.get(locale);
// .. use cldr instance
getAsync
Uses the asynchronous loader to construct a Promise<CLDR> instance. Note that this will raise an error if no asynchronous loader has been configured.
Syntax
framework.getAsync(locale): Promise<CLDR>
Parameters
locale: string | Locale- An identifier for the locale to use
Example
import { framework } from './framework';
const locale = 'fr-CA';
framework.getAsync(locale).then(cldr => {
// .. use cldr instance, call setState on component, send action to Redux store, etc.
});
parseLanguageTag
Parse a BCP 47 language tag or Java locale identifier, returning a LanguageTag object.
Syntax
static parseLanguageTag(id): LanguageTag
Parameters
id: string- Identifier to parse
Example
import { CLDRFramework } from '@phensley/cldr';
const { parseLanguageTag } = CLDRFramework;
const ids = [
'en-US',
'und-Latn-ZZ',
'fr_CA',
'no-GB-u-ca-gregory-u-nu-mathmono'
];
for (const id of ids) {
const tag = parseLanguageTag(id);
log(tag.language());
log(tag.script());
log(tag.region());
log(tag.compact());
log(tag.expanded());
log(tag.extensions());
log();
}
en
Zzzz
US
en-US
en-Zzzz-US
{}
und
Latn
ZZ
und-Latn
und-Latn-ZZ
{}
fr
Zzzz
CA
fr-CA
fr-Zzzz-CA
{}
no
Zzzz
GB
no-GB-u-ca-gregory-nu-mathmono
no-Zzzz-GB-u-ca-gregory-nu-mathmono
{ u: [ 'ca-gregory', 'nu-mathmono' ] }
See Also
resolveLocale
Parses a BCP 47 language tag or Java locale identifier and resolves it, returning a Locale object.
Syntax
static resolveLocale(id): Locale
Parameters
id: string | LanguageTag- Identifier or language tag to resolve
Example
import { CLDRFramework } from '@phensley/cldr';
const { resolveLocale } = CLDRFramework;
for (const str of ['en_US', 'zh', 'fr-CA-u-ca-persian-u-nu-mathmono']) {
const { id, tag } = resolveLocale(str);
log(`${tag.expanded()}`);
}
en-Latn-US zh-Hans-CN fr-Latn-CA-u-ca-persian-nu-mathmono
import { CLDRFramework } from '@phensley/cldr';
const { parseLanguageTag, resolveLocale } = CLDRFramework;
for (const s of ['und-US', 'fr']) {
const parsed = parseLanguageTag(s);
const resolved = resolveLocale(parsed);
log(`${parsed.expanded()} ${resolved.tag.compact()}`);
}
und-Zzzz-US en-Latn-US fr-Zzzz-ZZ fr-Latn-FR