iso-country-codes-converter v1.0.7

Installation

You can install the package using npm or yarn:

npm install convert-iso-country-codes

Usage

iso-country-codes-converter is fully TypeScript-supported, ensuring type safety and improved development experience. Additionally, it boasts 100% code test coverage, which guarantees the reliability and stability of the library.

Converting ISO 2 to ISO 3

import { convertISO2ToISO3 } from "convert-iso-country-codes";

const iso3Code = convertISO2ToISO3("US"); // Returns 'USA'

Converting ISO 3 to ISO 2

import { convertISO3ToISO2 } from "convert-iso-country-codes";

const iso2Code = convertISO3ToISO2("USA"); // Returns 'US'

Converting ISO 3 to Numeric

import { convertISO3ToNumeric } from "convert-iso-country-codes";

const numericCode = convertISO3ToNumeric("USA"); // Returns 840

Converting Numeric to ISO 3

import { convertNumericToISO2 } from "convert-iso-country-codes";

const iso2Code = convertNumericToISO3(840); // Returns 'USA'

Converting ISO 2 to Numeric

import { convertISO2ToNumeric } from "convert-iso-country-codes";

const numericCode = convertISO2ToNumeric("US"); // Returns 840

Converting Numeric to ISO 2

import { convertNumericToISO2 } from "convert-iso-country-codes";

const iso2Code = convertNumericToISO2(840); // Returns 'US'

API

convert<Codes>(CodeFormat: CodeFormat): ConvertedCodeFormat

Converts a country code from one format to another.

• Parameters: CodeFormat: ISO3, ISO2, Numeric
• Returns: ConvertedCodeFormat The corresponding converted country code.
• Throws: Error If the input code is not valid.

Types

ISO2Code: A union type of all valid ISO 2 country codes.

ISO3Code: A union type of all valid ISO 3 country codes.

NumericCode: A union type of all valid numeric country codes.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch: git checkout -b feature/AmazingFeature
3. Commit your Changes: git commit -m 'Add some AmazingFeature'
4. Push to the Branch: git push origin feature/AmazingFeature
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Marius Adam - @Marius Adam LinkedIn

Project Link: https://github.com/Marius-Adam/iso-country-code-converter