Types

LocaleProperties

TypeScript interface containing comprehensive locale information

Overview

LocaleProperties provides detailed linguistic and regional information about a locale.

interface LocaleProperties {
  code: string;
  name: string;
  nativeName: string;
  languageCode: string;
  languageName: string;
  nativeLanguageName: string;
  nameWithRegionCode: string;
  nativeNameWithRegionCode: string;
  regionCode: string;
  regionName: string;
  nativeRegionName: string;
  scriptCode: string;
  scriptName: string;
  nativeScriptName: string;
  maximizedCode: string;
  maximizedName: string;
  nativeMaximizedName: string;
  minimizedCode: string;
  minimizedName: string;
  nativeMinimizedName: string;
  emoji: string;
}

Returned by getLocaleProperties methods.

Key Properties

PropertyDescription
codeOriginal locale code
nameDisplay name in source language
nativeNameDisplay name in native language
languageCodeBase language code
regionCodeISO region code
scriptCodeISO script code
maximizedCodeLocale with likely script/region
minimizedCodeShortest valid locale code
emojiFlag emoji

Examples

Basic Usage

const gt = new GT({ sourceLocale: 'en-US' });
const props = gt.getLocaleProperties('de-AT');

console.log(props.name);        // "Austrian German"
console.log(props.nativeName);  // "Österreichisches Deutsch"
console.log(props.emoji);       // "🇦🇹"

How is this guide?

LocaleProperties