iso-3166-1-ts

Provides ISO 3166-1 values and types. Country codes are fetched from takuma7/iso-3166-1-csv, which contains up-to-date canonical codes scraped from ISO's website.

Installation

1yarn add iso-3166-1-ts

Usage

findBy* methods let you find an ISO 3166-1 record. If not found, they return undefined.

1import {
2  findByAlpha2,
3  findByAlpha3,
4  findByNumeric,
5} from 'iso-3166-1-ts'
6
7console.log(findByAlpha2('AF'))
8console.log(findByAlpha2('af'))
9console.log(findByAlpha3('AFG'))
10console.log(findByAlpha3('afg'))
11console.log(findByNumeric('004'))
12console.log(findByNumeric(4))
13// All the above will output:
14// {
15//   alpha2: "AF",
16//   alpha3: "AFG",
17//   name: "Afghanistan",
18//   name_fr: "Afghanistan (l')",
19//   numeric: "004",
20// }
21
22

This package also exports the data so you can play with it as you wish:

1import {
2  records,
3  alpha2Codes,
4  alpha3Codes,
5  names,
6  namesFr,
7} from 'iso-3166-1-ts'
8
9alpha2Codes.forEach((code) => {
10  // e.g.) Get more information from ISO website
11  const url = `https://www.iso.org/obp/ui/#iso:code:3166:${code}`
12  // ...
13})

You can also use types:

1import { Alpha2Code } from 'iso-3166-1-ts'
2
3export interface User {
4  name: string
5  country: Alpha2Code
6}
7
8const u: User = { name: 'foo', country: 'whatever' } // doesn't compile

For more details, please refer to the API reference.