Welcome to iso-3166-utils 👋

A helper to get country codes following the ISO 3316

Install

npm install iso-3166-utils

or

yarn add iso-3166-utils

Usage

This is the Country type:

type Country = {
  name: string;
  alpha2: string;
  alpha3: string;
  code: string;
};

And this is the subdivision US type:

type US = {
  name: string;
  code: string;
  category: string;
};

You can get all the countries just calling

import { country } from "iso-3166-utils";

const countries = country.data;

You can get a country by its name with getFromName:

import { country } from "iso-3166-utils";

const US = country.getFromName("United States of America");

You can get a country by its alpha2 value with getFromAlpha2:

import { country } from "iso-3166-utils";

const US = country.getFromAlpha2("US");

You can get a country by its alpha3 value with getFromAlpha3:

import { country } from "iso-3166-utils";

const US = country.getFromAlpha3("USA");

You can get a country by its code with getFromAlpha3:

import { country } from "iso-3166-utils";

const US = country.getFromCode("840");

And you can have the same for subdivisions, like AK:

import { subdivision } from "iso-3166-utils";

const AK = subdivision.us.getFromCode("AK");

Or you can get it from the name:

import { subdivision } from "iso-3166-utils";

const AK = subdivision.us.getFromName("Alaska");

You can find a full list of countries from the source

You can find a full list of subdivisions from the source

Author

👤 Pedro Filho pedro@filho.me

• Twitter: @pedrofilhome
• Github: @pedroapfilho

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!