Skip to content

pedroapfilho/iso-3166-utils

Repository files navigation

iso-3166-utils

NPM version Bundle size MIT

A helper to get country codes following the ISO 3316

Install

npm install iso-3166-utils

Usage

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

Next steps

  • Add more tests
  • Add more countries for subdivisions (possibly auto-generate this list)

🤝 Contributing

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published