@zerodep/geo.countryiso NPM

@zerodep/geo.countryiso

language types

last commit vulnerabilities

A utility to get the two-letter ISO code for a country from its name or common abbreviation.

This utility handles common abbreviations, upper/lower case values, as well as accents and diacritics. It may be configured to throw an error if a result is not found, default behaviour is to return undefined.

tl;dr

A short explanation / quick reference:

import { geoCountryIso } from '@zerodep/geo.countryiso';

geoCountryIso('United States of America'); // "US"
geoCountryIso('United States'); // "US"
geoCountryIso('U.S.A'); // "US"
geoCountryIso('U-S-A'); // "US"
geoCountryIso('u-s'); // "US"
geoCountryIso('us'); // "US"

geoCountryIso('unknown'); // undefined
geoCountryIso('unknown', true); // throws ZeroDepError

Install

This utility is available from multiple @zerodep packages, enabling developers to select the most appropriately sized package (for both kb and capability) for different use cases. We believe one size does not fit all or most. See @zerodep/app and @zerodep/geos.

// all @zerodep features, capabilities and utilities
npm install @zerodep/app

// all @zerodep "geo" utilities
npm install @zerodep/geo

// only the geo.countryiso package
npm install @zerodep/geo.countryiso

Of course, you may use yarn, pnpm, or the package manager of your choice. Only npm examples are shown for brevity.

This package may also be found on both jsDelivr and unpkg in UMD, ESM and CJS formats.

How to Use

This package exports the following:

Functions
- geoCountryIso - a function/geo that checks a string for known country values
Error types
- ZeroDepError - thrown if the state is not found, is an instance of the base Error object

Signature

Typescript declarations:

declare const geoCountryIso: (value: string, throwIfNotFound: false) => string | undefined;

Examples

All examples assume ESM or CJS packages. If using a UMD package remember to prefix with the zd namespace, e.g. zd.geoCountryIso(...).

Simple Example

// import from the most appropriate @zerodep package for your needs / specific use case (see the Install section above)
import { geoCountryIso } from '@zerodep/geo.countryiso';

geoCountryIso("Côte d'Ivoire"); // "CI"
geoCountryIso("cote d'ivoire"); // "CI"
geoCountryIso("Ivory Coast"); // "CI"
geoCountryIso("CIV"); // "CI"
geoCountryIso("ci"); // "CI"

// unknown countries
geoCountryIso('unknown'); // undefined
geoCountryIso('unknown', true); // throws a ZeroDepError

// value is not a string
geoCountryIso(123); // throws a ZeroDepError
geoCountryIso({ an: 'object' }); // throws a ZeroDepError

Related Packages

The following @zerodep packages may be helpful or more appropriate for your specific case:

@zerodep/geo.stateiso - converts a state or province name or abbreviation to its 2-letter ISO code

Advantages of @zerodep Packages

We help make source code more readable, more secure, faster to craft, less likely to have hidden defects, and easier to maintain.

Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
Fully typed - typescript definitions are provided for every package for a better developer experience
Semantically named - package and method names are easy to grok, remember, use, and read
Documented - actually useful documentation with examples and helpful tips
Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
100% Tested - all methods and packages are fully unit tested
ESM & CJS - has both ecmascript modules and common javascript exports, both are fully tree-shakable
CDN Available - available on fast content delivery networks in UMD, CJS and ESM formats
FP Inspired - gently opinionated to encourage functional programming style for cleaner and more maintainable software
Predictably Versioned - semantically versioned for peace-of-mind upgrading, this includes changelogs
MIT Licensed - permissively licensed for maximum usability

Support

All @zerodep packages are built for the ES2020 specification. Should you need to support older environments you will need to add appropriate polyfills. All packages are tested on the following platforms/browsers:

Browsers

Chrome - last 2 major versions
Firefox - last 2 major versions
Safari - last 2 major versions
Edge - last 2 major versions
Android - last 2 major versions
iOS - last 2 major versions

Node

v16.x - Gallium LTS
v14.x - Fermium LTS

It is likely the package will work on other technologies and version, however development and testing effort is only spent on the above.

Semver

All @zerodep packages, including this one, adhere to Semantic Versioning practices:

major versions: correlates with breaking changes to one or more method signatures
minor versions: includes addition of new functionality or backwards-compatible software improvements
patch versions: are reserved for copy changes, documentation enhancements and bug fixes

The above said, a security best practice is to pin your software packages to specific versions and only upgrade to more recent releases after careful inspection of any CHANGELOG, release notes and all software changes.