This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

iso-country-utils
TypeScript icon, indicating that this package has built-in type declarations

1.1.3 • Public • Published

Welcome to iso-country-utils 👋

NPM version Bundle size MIT

A helper to get country codes following the ISO 3316

Install

npm install iso-country-utils

or

yarn add iso-country-utils

Usage

This is the Country type:

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

You can get all the countries just calling

import { countries } from 'iso-country-utils';

You can get a country by its name with getCountryFromName:

import { getCountryFromName } from 'iso-country-utils';

const US = getCountryFromName('United States of America');

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

import { getCountryFromAlpha2 } from 'iso-country-utils';

const US = getCountryFromAlpha2('US');

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

import { getCountryFromAlpha3 } from 'iso-country-utils';

const US = getCountryFromAlpha3('USA');

You can get a country by its code with getCountryFromAlpha3:

import { getCountryFromCode } from 'iso-country-utils';

const US = getCountryFromCode('840');

You can find a full list of countries from the source

Author

👤 Pedro Filho pedro@filho.me

🤝 Contributing

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

Show your support

Give a ⭐️ if this project helped you!

Buy Me A Coffee


Readme

Keywords

Package Sidebar

Install

npm i iso-country-utils

Weekly Downloads

362

Version

1.1.3

License

MIT

Unpacked Size

99.5 kB

Total Files

19

Last publish

Collaborators

  • pedroapfilho