Country Code FAQ: Common Questions Answered

import { country } from '@koshmoney/countries';
 
// Convert between formats
country.alpha2ToAlpha3('US');    // 'USA'
country.alpha3ToAlpha2('GBR');   // 'GB'
country.alpha2ToNumeric('DE');   // '276'
country.numericToAlpha2(840);    // 'US'

import { country } from '@koshmoney/countries';
 
const all = country.all();
console.log(all.length); // 249

import { country } from '@koshmoney/countries';
 
// Validate any format
country.isAlpha2('US');     // true
country.isAlpha3('USA');    // true
country.isValid('US');      // true (any format)
country.isValid('XX');      // false
 
// Detect the format
country.detectFormat('US');    // 'alpha2'
country.detectFormat('USA');   // 'alpha3'
country.detectFormat('840');   // 'numeric'

import { country } from '@koshmoney/countries';
country.whereAlpha2('US');
// { name: 'United States', alpha2: 'US', alpha3: 'USA', numeric: '840' }

country.whereAlpha2('GB');
// { name: 'United Kingdom', alpha2: 'GB', alpha3: 'GBR', numeric: '826' }
 
country.isAlpha2('UK'); // false -- UK is not a valid ISO code

country.whereAlpha2('DE');
// { name: 'Germany', alpha2: 'DE', alpha3: 'DEU', numeric: '276' }

import { subdivision } from '@koshmoney/countries';
 
// Get all US states
const usStates = subdivision.forCountry('US');
// [{ code: 'US-AL', name: 'Alabama', type: 'State' }, ...]
 
// Look up a specific subdivision
subdivision.whereCode('US-CA');
// { code: 'US-CA', name: 'California', type: 'State', countryCode: 'US', regionCode: 'CA' }
 
// Validate a subdivision belongs to a country
subdivision.isValidRegion('US', 'CA');  // true
subdivision.isValidRegion('US', 'ON');  // false (ON is Canadian)

import { membership } from '@koshmoney/countries/membership';
 
membership.isEU('FR');   // true (France)
membership.isEU('CH');   // false (Switzerland)
membership.isEU('GB');   // false (UK left the EU)
 
// Get all EU members
const euMembers = membership.getMembers('EU');  // 27 countries

import { postalCode } from '@koshmoney/countries';
 
postalCode.isValid('US', '90210');       // true
postalCode.isValid('GB', 'SW1A 1AA');    // true
postalCode.isValid('US', 'ABCDE');       // false
 
// Get the local name for postal codes
postalCode.getName('US');   // 'ZIP Code'
postalCode.getName('IN');   // 'PIN Code'
postalCode.getName('DE');   // 'PLZ'
 
// Get format pattern
postalCode.getFormat('US');  // 'NNNNN or NNNNN-NNNN'
postalCode.getFormat('CA');  // 'A1A 1A1'

import { currency } from '@koshmoney/countries/currency';
 
currency.getCurrency('US');
// { code: 'USD', symbol: '$', name: 'US Dollar' }
 
currency.getCurrency('JP');
// { code: 'JPY', symbol: '\u00a5', name: 'Japanese Yen' }
 
// Reverse lookup: which countries use EUR?
currency.getCountriesByCurrency('EUR');
// ['AT', 'BE', 'CY', 'DE', 'EE', 'ES', 'FI', 'FR', ...]

import { country } from '@koshmoney/countries';
 
country.whereName('United States');
// { name: 'United States', alpha2: 'US', alpha3: 'USA', numeric: '840' }
 
country.whereName('Germany');
// { name: 'Germany', alpha2: 'DE', alpha3: 'DEU', numeric: '276' }

import { geography } from '@koshmoney/countries/geography';
 
geography.getContinent('US');  // 'North America'
geography.getContinent('JP');  // 'Asia'
geography.getContinent('NG');  // 'Africa'
 
geography.getRegion('US');     // 'Northern America'
geography.getRegion('JP');     // 'Eastern Asia'
geography.getRegion('NG');     // 'Western Africa'
 
// Get all countries in a continent
geography.countriesInContinent('Europe');
// ['AD', 'AL', 'AT', 'AX', 'BA', 'BE', 'BG', ...]

// Core modules from the main bundle (~8KB for countries only)
import { country } from '@koshmoney/countries';
 
// Specialized modules via subpath imports (only loaded when imported)
import { currency } from '@koshmoney/countries/currency';
import { geography } from '@koshmoney/countries/geography';
import { membership } from '@koshmoney/countries/membership';
 
// Per-country subdivision imports
import '@koshmoney/countries/subdivision/US';  // Only US subdivisions
import '@koshmoney/countries/subdivision/CA';  // Only CA subdivisions

import { postalCode } from '@koshmoney/countries';
 
postalCode.hasPostalCode('HK');  // false
postalCode.hasPostalCode('US');  // true