UNPKG

@fruitsbytes/country-list-ts

Version:

It contains country information including 2 and 3 character ISO codes, country and capital names, currency information, telephone calling codes, and provinces ( first-tier political subdivisions).

2,219 lines (2,218 loc) 2.64 MB
declare const CCA_2_ARRAY: string[]; type CCA2 = (typeof CCA_2_ARRAY)[number]; declare const TLD_ARRAY: string[]; type TLD = (typeof TLD_ARRAY)[number]; declare const CCN_3_ARRAY: string[]; type CCN3 = (typeof CCN_3_ARRAY)[number]; declare const CCA_3_ARRAY: string[]; type CCA3 = (typeof CCA_3_ARRAY)[number]; declare const CIOC_ARRAY: string[]; type CIOC = (typeof CIOC_ARRAY)[number]; declare const COUNTRY_STATUS_ARRAY: string[]; type CountryStatus = (typeof COUNTRY_STATUS_ARRAY)[number]; declare const COMMON_NAME_ARRAY: string[]; type CommonName = (typeof COMMON_NAME_ARRAY)[number]; declare const OFFICIAL_NAME_ARRAY: string[]; type OfficialName = (typeof OFFICIAL_NAME_ARRAY)[number]; declare const CURRENCY_CODE_ARRAY: string[]; type CurrencyCode = (typeof CURRENCY_CODE_ARRAY)[number]; declare const CURRENCY_NAME_ARRAY: string[]; type CurrencyName = (typeof CURRENCY_NAME_ARRAY)[number]; declare const CURRENCY_SYMBOL_ARRAY: string[]; type CurrencySymbol = (typeof CURRENCY_SYMBOL_ARRAY)[number]; declare const REGION_ARRAY: string[]; type Region = (typeof REGION_ARRAY)[number]; declare const SUB_REGION_ARRAY: string[]; type SubRegion = (typeof SUB_REGION_ARRAY)[number]; declare const CAPITAL_ARRAY: string[]; type Capital = (typeof CAPITAL_ARRAY)[number]; declare const LANG_ARRAY: string[]; type Lang = (typeof LANG_ARRAY)[number]; declare const LANGUAGE_NAME_ARRAY: string[]; type LanguageName = (typeof LANGUAGE_NAME_ARRAY)[number]; type Mapped<K extends string, V> = Partial<{ [k in K]: V; }>; interface Currency { name: CurrencyName; symbol: CurrencySymbol; } interface Name { common: string; official: string; native: Mapped<Lang, { official: string; common: string; }>; } type LatLong = [number, number]; interface InternationalDirectDialing { root: string; suffixes: string[]; } interface Country { name: Name; tld: string[]; cca2: CCA2; ccn3: CCN3; cca3: CCA3; cioc: CIOC; independent: boolean; status: CountryStatus; unMember: boolean; currencies: Mapped<CurrencyCode, Currency> | []; idd: InternationalDirectDialing; capital: Capital[]; altSpellings: string[]; region: Region; subregion: SubRegion; languages: Mapped<Lang, LanguageName>; translations: Mapped<Lang, { official: string; common: string; }>; latlng: LatLong; demonyms: Mapped<Lang, { f: string; m: string; }>; landlocked: boolean; borders: CCA3[]; area: number; callingCodes: string[]; flag: string; } type Listable = 'default' | 'cca2' | 'tld' | 'ccn3' | 'cca3' | 'cioc' | 'countryStatus' | 'commonName' | 'officialName' | 'currencyCode' | 'currencyName' | 'currencySymbol' | 'region' | 'subRegion' | 'capital' | 'lang' | 'languageName'; type List = [] | Array<CCA2> | Array<TLD> | Array<CCN3> | Array<CCA3> | Array<CIOC> | Array<CountryStatus> | Array<CommonName> | Array<OfficialName> | Array<CurrencyCode> | Array<CurrencyName> | Array<CurrencySymbol> | Array<Region> | Array<SubRegion> | Array<Capital> | Array<Lang> | Array<LanguageName>; type Mappable = 'default' | 'name' | 'tld' | 'ccn3' | 'cca3' | 'cioc' | 'independent' | 'idd' | 'countryStatus' | 'currencies' | 'region' | 'subRegion' | 'capitals' | 'languages' | 'translations' | 'latLng' | 'landlocked' | 'borders' | 'area' | 'flag' | 'demonyms' | 'callingCodes'; /** * Get the SVG flag * @param {CCA2}cca2 - The ISO2 code of the country * @return{SVGElement} - returns a svg */ export function flag(cca2?: CCA2): Promise<string>; /** * Get the Geo-Json data of a country * @param cca2 - The ISO2 code of the country * @return{string} JSON */ export function geo(cca2?: CCA2): Promise<object>; /** * Get the Topo-Json data of a country * @param cca2 - The ISO2 code of the country * @return{string} JSON */ export function topo(cca2?: CCA2): Promise<object>; /** * ### List of string values * @param {Listable} property - listable property * @return {Promise<string[]>} Array */ export function ls(property?: Listable): Promise<List>; /** * List cca2 values */ export function cca2s(): Promise<CCA2[]>; /** * List tld values */ export function tlds(): Promise<TLD[]>; /** * List ccn3 values */ export function ccn3s(): Promise<CCN3[]>; /** * List cca3 values */ export function cca3s(): Promise<CCA3[]>; /** * List cioc values */ export function ciocs(): Promise<CIOC[]>; /** * List country status values */ export function countryStatuses(): Promise<CountryStatus[]>; /** * List common name values */ export function commonNames(): Promise<CommonName[]>; /** * List official name values */ export function officialNames(): Promise<OfficialName[]>; /** * List currency code values */ export function currencyCodes(): Promise<CurrencyCode[]>; /** * List currency name values */ export function currencyNames(): Promise<CurrencyName[]>; /** * List currency symbol values */ export function currencySymbols(): Promise<CurrencySymbol[]>; /** * List region values */ export function regions(): Promise<Region[]>; /** * List subRegion values */ export function subRegions(): Promise<SubRegion[]>; /** * List capital values */ export function capitals(): Promise<Capital[]>; /** * List lang values */ export function langs(): Promise<Lang[]>; /** * List languageName values */ export function languageNames(): Promise<LanguageName[]>; /** * ### Mapped list of string values * * Example: * ``` * const topLevelDomains = lsM('tld'); // {'HT': ['.ht'], ...} * ``` * @param {Mappable} property - mappable property * @return {Record<string, any>} - a Record of values. */ export function lsM(property?: Mappable): Promise<{ AW: { common: string; official: string; native: { nld: { official: string; common: string; }; pap: { official: string; common: string; }; }; }; AF: { common: string; official: string; native: { prs: { official: string; common: string; }; pus: { official: string; common: string; }; tuk: { official: string; common: string; }; }; }; AO: { common: string; official: string; native: { por: { official: string; common: string; }; }; }; AI: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; AX: { common: string; official: string; native: { swe: { official: string; common: string; }; }; }; AL: { common: string; official: string; native: { sqi: { official: string; common: string; }; }; }; AD: { common: string; official: string; native: { cat: { official: string; common: string; }; }; }; AE: { common: string; official: string; native: { ara: { official: string; common: string; }; }; }; AR: { common: string; official: string; native: { grn: { official: string; common: string; }; spa: { official: string; common: string; }; }; }; AM: { common: string; official: string; native: { hye: { official: string; common: string; }; }; }; AS: { common: string; official: string; native: { eng: { official: string; common: string; }; smo: { official: string; common: string; }; }; }; AQ: { common: string; official: string; native: {}; }; TF: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; AG: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; AU: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; AT: { common: string; official: string; native: { bar: { official: string; common: string; }; }; }; AZ: { common: string; official: string; native: { aze: { official: string; common: string; }; rus: { official: string; common: string; }; }; }; BI: { common: string; official: string; native: { fra: { official: string; common: string; }; run: { official: string; common: string; }; }; }; BE: { common: string; official: string; native: { deu: { official: string; common: string; }; fra: { official: string; common: string; }; nld: { official: string; common: string; }; }; }; BJ: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; BF: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; BD: { common: string; official: string; native: { ben: { official: string; common: string; }; }; }; BG: { common: string; official: string; native: { bul: { official: string; common: string; }; }; }; BH: { common: string; official: string; native: { ara: { official: string; common: string; }; }; }; BS: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; BA: { common: string; official: string; native: { bos: { official: string; common: string; }; hrv: { official: string; common: string; }; srp: { official: string; common: string; }; }; }; BL: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; SH: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; BY: { common: string; official: string; native: { bel: { official: string; common: string; }; rus: { official: string; common: string; }; }; }; BZ: { common: string; official: string; native: { bjz: { official: string; common: string; }; eng: { official: string; common: string; }; spa: { official: string; common: string; }; }; }; BM: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; BO: { common: string; official: string; native: { aym: { official: string; common: string; }; grn: { official: string; common: string; }; que: { official: string; common: string; }; spa: { official: string; common: string; }; }; }; BQ: { /** * List cca3 values */ common: string; official: string; native: { nld: { official: string; common: string; }; pap: { official: string; common: string; }; }; }; BR: { common: string; official: string; native: { por: { /** * List common name values */ official: string; common: string; }; }; }; BB: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; BN: { common: string; official: string; native: { msa: { official: string; common: string; }; }; }; BT: { common: string; official: string; native: { dzo: { official: string; common: string; }; }; }; BV: { common: string; official: string; native: { /** * List currency symbol values */ nor: { official: string; common: string; }; }; }; BW: { common: string; official: string; native: { eng: { official: string; common: string; }; tsn: { official: string; common: string; }; }; }; CF: { common: string; official: string; native: { fra: { official: string; /** * List capital values */ common: string; }; sag: { official: string; common: string; }; }; }; CA: { common: string; official: string; native: { eng: { official: string; common: string; }; fra: { official: string; common: string; }; }; }; CC: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; CH: { common: string; official: string; native: { fra: { official: string; common: string; }; gsw: { official: string; common: string; }; ita: { official: string; common: string; }; roh: { official: string; common: string; }; }; }; CL: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; CN: { common: string; official: string; native: { zho: { official: string; common: string; }; }; }; CI: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; CM: { common: string; official: string; native: { eng: { official: string; common: string; }; fra: { official: string; common: string; }; }; }; CD: { common: string; official: string; native: { fra: { official: string; common: string; }; kon: { official: string; common: string; }; lin: { official: string; common: string; }; lua: { official: string; common: string; }; swa: { official: string; common: string; }; }; }; CG: { common: string; official: string; native: { fra: { official: string; common: string; }; kon: { official: string; common: string; }; lin: { official: string; common: string; }; }; }; CK: { common: string; official: string; native: { eng: { official: string; common: string; }; rar: { official: string; common: string; }; }; }; CO: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; KM: { common: string; official: string; native: { ara: { official: string; common: string; }; fra: { official: string; common: string; }; zdj: { official: string; common: string; }; }; }; CV: { common: string; official: string; native: { por: { official: string; common: string; }; }; }; CR: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; CU: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; CW: { common: string; official: string; native: { eng: { official: string; common: string; }; nld: { official: string; common: string; }; pap: { official: string; common: string; }; }; }; CX: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; KY: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; CY: { common: string; official: string; native: { ell: { official: string; common: string; }; tur: { official: string; common: string; }; }; }; CZ: { common: string; official: string; native: { ces: { official: string; common: string; }; slk: { official: string; common: string; }; }; }; DE: { common: string; official: string; native: { deu: { official: string; common: string; }; }; }; DJ: { common: string; official: string; native: { ara: { official: string; common: string; }; fra: { official: string; common: string; }; }; }; DM: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; DK: { common: string; official: string; native: { dan: { official: string; common: string; }; }; }; DO: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; DZ: { common: string; official: string; native: { ara: { official: string; common: string; }; }; }; EC: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; EG: { common: string; official: string; native: { ara: { official: string; common: string; }; }; }; ER: { common: string; official: string; native: { ara: { official: string; common: string; }; eng: { official: string; common: string; }; tir: { official: string; common: string; }; }; }; EH: { common: string; official: string; native: { ber: { official: string; common: string; }; mey: { official: string; common: string; }; spa: { official: string; common: string; }; }; }; ES: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; EE: { common: string; official: string; native: { est: { official: string; common: string; }; }; }; ET: { common: string; official: string; native: { amh: { official: string; common: string; }; }; }; FI: { common: string; official: string; native: { fin: { official: string; common: string; }; swe: { official: string; common: string; }; }; }; FJ: { common: string; official: string; native: { eng: { official: string; common: string; }; fij: { official: string; common: string; }; hif: { official: string; common: string; }; }; }; FK: { common: string; official: string; /** * ### Get a list of all the countries * @return {Country[]} All the countries */ native: { eng: { official: string; common: string; }; }; }; FR: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; FO: { common: string; official: string; native: { dan: { official: string; common: string; }; fao: { official: string; common: string; }; }; }; FM: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; GA: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; GB: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; GE: { common: string; official: string; native: { kat: { official: string; common: string; }; }; }; GG: { common: string; official: string; native: { eng: { official: string; common: string; }; fra: { official: string; common: string; }; nfr: { official: string; common: string; }; }; }; GH: { common: string; official: string; /** * ### Search for Countries * * example: * ```javascript * const tropicals = get("region", "Caribbean") ; * ``` * @param {string} property Searchable property * @param {string} value Property value * @return {Country[]} */ native: { eng: { official: string; common: string; }; }; }; GI: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; GN: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; GP: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; GM: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; GW: { common: string; official: string; native: { por: { official: string; common: string; }; pov: { official: string; common: string; }; }; }; GQ: { common: string; official: string; native: { fra: { official: string; common: string; }; por: { official: string; common: string; }; spa: { official: string; common: string; }; }; }; GR: { common: string; official: string; native: { ell: { official: string; common: string; }; }; }; GD: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; GL: { common: string; official: string; native: { kal: { official: string; common: string; }; }; }; GT: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; GF: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; GU: { common: string; official: string; native: { cha: { official: string; common: string; }; eng: { official: string; common: string; }; spa: { official: string; common: string; }; }; }; GY: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; HK: { common: string; official: string; native: { eng: { official: string; common: string; }; zho: { official: string; common: string; }; }; }; HM: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; HN: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; HR: { common: string; official: string; native: { hrv: { official: string; common: string; }; }; }; HT: { common: string; official: string; native: { fra: { official: string; common: string; }; hat: { official: string; common: string; }; }; }; HU: { common: string; official: string; native: { hun: { official: string; common: string; }; }; }; ID: { common: string; official: string; native: { ind: { official: string; common: string; }; }; }; IM: { common: string; official: string; native: { eng: { official: string; common: string; }; glv: { official: string; common: string; }; }; }; IN: { common: string; official: string; native: { eng: { official: string; common: string; }; hin: { official: string; common: string; }; tam: { official: string; common: string; }; }; }; IO: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; IE: { common: string; official: string; native: { eng: { official: string; common: string; }; gle: { official: string; common: string; }; }; }; IR: { common: string; official: string; native: { fas: { official: string; common: string; }; }; }; IQ: { common: string; official: string; native: { ara: { official: string; common: string; }; arc: { official: string; common: string; }; ckb: { official: string; common: string; }; }; }; IS: { common: string; official: string; native: { isl: { official: string; common: string; }; }; }; IL: { common: string; official: string; native: { ara: { official: string; common: string; }; heb: { official: string; common: string; }; }; }; IT: { common: string; official: string; native: { ita: { official: string; common: string; }; }; }; JM: { common: string; official: string; native: { eng: { official: string; common: string; }; jam: { official: string; common: string; }; }; }; JE: { common: string; official: string; native: { eng: { official: string; common: string; }; fra: { official: string; common: string; }; nrf: { official: string; common: string; }; }; }; JO: { common: string; official: string; native: { ara: { official: string; common: string; }; }; }; JP: { common: string; official: string; native: { jpn: { official: string; common: string; }; }; }; KZ: { common: string; official: string; native: { kaz: { official: string; common: string; }; rus: { official: string; common: string; }; }; }; KE: { common: string; official: string; native: { eng: { official: string; common: string; }; swa: { official: string; common: string; }; }; }; KG: { common: string; official: string; native: { kir: { official: string; common: string; }; rus: { official: string; common: string; }; }; }; KH: { common: string; official: string; native: { khm: { official: string; common: string; }; }; }; KI: { common: string; official: string; native: { eng: { official: string; common: string; }; gil: { official: string; common: string; }; }; }; KN: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; KR: { common: string; official: string; native: { kor: { official: string; common: string; }; }; }; XK: { common: string; official: string; native: { sqi: { official: string; common: string; }; srp: { official: string; common: string; }; }; }; KW: { common: string; official: string; native: { ara: { official: string; common: string; }; }; }; LA: { common: string; official: string; native: { lao: { official: string; common: string; }; }; }; LB: { common: string; official: string; native: { ara: { official: string; common: string; }; fra: { official: string; common: string; }; }; }; LR: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; LY: { common: string; official: string; native: { ara: { official: string; common: string; }; }; }; LC: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; LI: { common: string; official: string; native: { deu: { official: string; common: string; }; }; }; LK: { common: string; official: string; native: { sin: { official: string; common: string; }; tam: { official: string; common: string; }; }; }; LS: { common: string; official: string; native: { eng: { official: string; common: string; }; sot: { official: string; common: string; }; }; }; LT: { common: string; official: string; native: { lit: { official: string; common: string; }; }; }; LU: { common: string; official: string; native: { deu: { official: string; common: string; }; fra: { official: string; common: string; }; ltz: { official: string; common: string; }; }; }; LV: { common: string; official: string; native: { lav: { official: string; common: string; }; }; }; MO: { common: string; official: string; native: { por: { official: string; common: string; }; zho: { official: string; common: string; }; }; }; MF: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; MA: { common: string; official: string; native: { ara: { official: string; common: string; }; ber: { official: string; common: string; }; }; }; MC: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; MD: { common: string; official: string; native: { ron: { official: string; common: string; }; }; }; MG: { common: string; official: string; native: { fra: { official: string; common: string; }; mlg: { official: string; common: string; }; }; }; MV: { common: string; official: string; native: { div: { official: string; common: string; }; }; }; MX: { common: string; official: string; native: { spa: { official: string; common: string; }; }; }; MH: { common: string; official: string; native: { eng: { official: string; common: string; }; mah: { official: string; common: string; }; }; }; MK: { common: string; official: string; native: { mkd: { official: string; common: string; }; }; }; ML: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; MT: { common: string; official: string; native: { eng: { official: string; common: string; }; mlt: { official: string; common: string; }; }; }; MM: { common: string; official: string; native: { mya: { official: string; common: string; }; }; }; ME: { common: string; official: string; native: { cnr: { official: string; common: string; }; }; }; MN: { common: string; official: string; native: { mon: { official: string; common: string; }; }; }; MP: { common: string; official: string; native: { cal: { official: string; common: string; }; cha: { official: string; common: string; }; eng: { official: string; common: string; }; }; }; MZ: { common: string; official: string; native: { por: { official: string; common: string; }; }; }; MR: { common: string; official: string; native: { ara: { official: string; common: string; }; }; }; MS: { common: string; official: string; native: { eng: { official: string; common: string; }; }; }; MQ: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; MU: { common: string; official: string; native: { eng: { official: string; common: string; }; fra: { official: string; common: string; }; mfe: { official: string; common: string; }; }; }; MW: { common: string; official: string; native: { eng: { official: string; common: string; }; nya: { official: string; common: string; }; }; }; MY: { common: string; official: string; native: { eng: { official: string; common: string; }; msa: { official: string; common: string; }; }; }; YT: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; NA: { common: string; official: string; native: { afr: { official: string; common: string; }; deu: { official: string; common: string; }; eng: { official: string; common: string; }; her: { official: string; common: string; }; hgm: { official: string; common: string; }; kwn: { official: string; common: string; }; loz: { official: string; common: string; }; ndo: { official: string; common: string; }; tsn: { official: string; common: string; }; }; }; NC: { common: string; official: string; native: { fra: { official: string; common: string; }; }; }; NE: {