TypeScript
/@infobits/intl

API-Referenz

API-Referenz

Eine vollständige Referenz aller öffentlichen APIs in jedem Paket.

Typen

Country

FeldTypBeschreibung
idstringEindeutiger Bezeichner (z.B. "unitedStates")
alpha2CodestringISO 3166-1 Alpha-2 (z.B. "US")
alpha3CodestringISO 3166-1 Alpha-3 (z.B. "USA")
numericCodenumberISO 3166-1 numerisch (z.B. 840)
nativeNamestringEinheimischer Ländername
capitalstringHauptstadt
mainLanguagestringPrimärer Sprachcode
languagesstring[]Alle gesprochenen Sprachcodes
tldstringTop-Level-Domain
callingCodenumberInternationale Vorwahl
continentstringKontinent-Bezeichner
currencystringWährungscode

Language

FeldTypBeschreibung
idstringEindeutiger Bezeichner (z.B. "english")
codestringISO 639-1 Code (z.B. "en")
nativeNamestringName in der jeweiligen Sprache
dialectsLanguageDialect[]Regionale Varianten
defaultFlagCodestring?Ländercode für repräsentative Flagge

LanguageDialect

FeldTypBeschreibung
idstringEindeutiger Bezeichner
codestringDialektcode
nativeNamestringEinheimischer Name des Dialekts
flagCodestring?Ländercode für die Flagge des Dialekts

Currency

FeldTypBeschreibung
idstringEindeutiger Bezeichner (z.B. "usd")
codestringISO 4217 Code (z.B. "USD")
nativeNamestringSingular-Name (z.B. "US Dollar")
nativeNamePluralstringPlural-Name (z.B. "US Dollars")
symbolstringWährungssymbol (z.B. "$")

Continent

FeldTypBeschreibung
idstringEindeutiger Bezeichner (z.B. "europe")
codestringZweibuchstaben-Code (z.B. "EU")
namestringEnglischer Anzeigename

Suchfunktionen

Länder

GoDartTypeScript
// TypeScript
getCountryByAlpha2(code: string): Country | undefined
getCountryByAlpha3(code: string): Country | undefined
getCountriesByContinent(continent: string): Country[]
getCountriesInContinent(code: string): Country[]

Sprachen

GoDartTypeScript
// TypeScript
getLanguageByCode(code: string): Language | undefined

Währungen

GoDartTypeScript
// TypeScript
getCurrencyByCode(code: string): Currency | undefined

Kontinente

GoDartTypeScript
// TypeScript
getContinentByCode(code: string): Continent | undefined

Flaggen

GoDartTypeScript
// TypeScript
getFlag(alpha2: string): string | undefined
flags  // Record<string, string>

Emoji-Flaggen

GoDartTypeScript
// TypeScript
getEmojiFlag(alpha2: string): string

Enums / Konstanten

Jedes Paket stellt typsichere Konstanten für alle Codes bereit:

GoDartTypeScript
// TypeScript — String-Enums
CountryCode.US    // "US"
LanguageCode.FR   // "FR"
CurrencyCode.EUR  // "EUR"
ContinentCode.EU  // "EU"

Übersetzungsfunktionen

Alle Übersetzungsfunktionen nehmen einen Entitätscode und einen Locale-Code entgegen und geben den lokalisierten Namen zurück.

Verfügbare Sprachen: da, de, en, es, fr, it, zh

GoDartTypeScript
// TypeScript
getCountriesName(code: string, locale: string): string | undefined
getLanguagesName(code: string, locale: string): string | undefined
getCurrenciesName(code: string, locale: string): string | undefined
getContinentsName(code: string, locale: string): string | undefined
getCapitalsName(code: string, locale: string): string | undefined

Übersetzungs-Maps

Für den Massenzugriff stehen die vollständigen Übersetzungs-Maps zur Verfügung:

GoDartTypeScript
// TypeScript
countriesTranslations   // Record<string, Record<string, string>>
languagesTranslations
currenciesTranslations
continentsTranslations
capitalsTranslations