Migration Guide

npm uninstall iso-3166-1
npm install @koshmoney/countries

import * as iso from 'iso-3166-1';
 
iso.whereAlpha2('US');
iso.whereAlpha3('USA');
iso.whereNumeric('840');
iso.whereCountry('UNITED STATES');
iso.all();

import { country } from '@koshmoney/countries';
 
country.whereAlpha2('US');
country.whereAlpha3('USA');
country.whereNumeric('840');
country.whereName('United States');  // Changed from whereCountry
country.all();

interface Country {
  country: string;  // "Norway"
  alpha2: string;
  alpha3: string;
  numeric: string;
}

interface Country {
  name: string;     // "Norway" (renamed from country)
  alpha2: string;
  alpha3: string;
  numeric: string;
}

npm uninstall iso-3166-2
npm install @koshmoney/countries

import * as iso3166 from 'iso-3166-2';
 
iso3166.subdivision('US-CA');
iso3166.subdivision('US', 'CA');
iso3166.subdivision('US', 'California');
iso3166.country('US');
iso3166.data;
iso3166.codes;

import { country, subdivision } from '@koshmoney/countries';
 
subdivision.whereCode('US-CA');
subdivision.where('US', 'CA');
subdivision.whereName('US', 'California');
country.withSubdivisions('US');

// Before: One function, multiple signatures
iso3166.subdivision('US-CA');           // by code
iso3166.subdivision('US', 'CA');        // by country + region
iso3166.subdivision('US', 'California'); // by country + name
 
// After: Explicit functions
subdivision.whereCode('US-CA');
subdivision.where('US', 'CA');
subdivision.whereName('US', 'California');

import { country } from '@koshmoney/countries';
 
country.alpha2ToAlpha3('US');     // 'USA'
country.alpha3ToAlpha2('USA');    // 'US'
country.alpha2ToNumeric('US');    // '840'
country.numericToAlpha2(840);     // 'US'
country.toName('USA');            // 'United States'

import { country, subdivision } from '@koshmoney/countries';
 
country.isAlpha2('US');           // true
country.isAlpha3('USA');          // true
country.isValid('US');            // true (any format)
country.detectFormat('USA');      // 'alpha3'
 
subdivision.isValidCode('US-CA');            // true
subdivision.isValidRegion('US', 'CA');       // true
subdivision.isValidName('US', 'California'); // true

import { postalCode } from '@koshmoney/countries';
 
postalCode.isValid('US', '90210');     // true
postalCode.isValid('GB', 'SW1A 1AA');  // true
postalCode.getName('US');              // 'ZIP Code'

import { currency } from '@koshmoney/countries/currency';
import { dialCode } from '@koshmoney/countries/dialCode';
import { geography } from '@koshmoney/countries/geography';
import { membership } from '@koshmoney/countries/membership';
 
currency.getCurrency('US');          // { code: 'USD', symbol: '$', name: 'US Dollar' }
dialCode.getDialCode('US');          // '+1'
geography.getContinent('US');        // 'North America'
membership.isEU('FR');               // true

// Import only country data (~8KB instead of ~60KB)
import { whereAlpha2 } from '@koshmoney/countries/country';
 
// Import specific country subdivisions
import '@koshmoney/countries/subdivision/US';
import { whereCode } from '@koshmoney/countries/subdivision';

import { country, subdivision } from '@koshmoney/countries';
 
export const iso3166 = {
  subdivision: (codeOrCountry: string, regionOrName?: string) => {
    if (regionOrName === undefined) {
      return subdivision.whereCode(codeOrCountry);
    }
    return subdivision.where(codeOrCountry, regionOrName) ||
           subdivision.whereName(codeOrCountry, regionOrName);
  },
 
  country: (code: string) => {
    return country.withSubdivisions(code);
  },
};