@zerodep/geo.stateiso

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

This utility handles common abbreviations, upper/lower case values, as well as accents and diacritics for states and provinces in the United States and Canada. 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 { geoStateIso } from '@zerodep/geo.stateiso';

geoStateIso('California'); // "CA"
geoStateIso('Cali'); // "CA"
geoStateIso('ca'); // "CA"

geoStateIso('British Columbia'); // "BC"
geoStateIso('b.c.'); // "BC"
geoStateIso('bc'); // "BC"

geoStateIso('unknown'); // undefined

Table of Contents

• Installation Instructions
• How to Use
  • Signature
  • Examples
• Related Packages
• ZeroDep Advantages
• Support
• Semver
• Resources
• License

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.stateiso package
npm install @zerodep/geo.stateiso

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
  • geoStateIso - a function/geo that checks a string for known state/province values
• Error types
  • ZeroDepError - thrown if the state is not found, is an instance of the base Error object

Signature

Typescript declarations:

declare const geoStateIso: (
  value: string,
  countryISO?: 'US' | 'CA',
  throwIfNotFound?: boolean
) => 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.geoStateIso(...).

Simple Example

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

geoStateIso('california'); // "CA"
geoStateIso('CALI'); // "CA"
geoStateIso('ca'); // "CA"

geoStateIso('Québec'); // "PQ"
geoStateIso('quebec'); // "PQ"
geoStateIso('pq'); // "PQ"

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

Using Country Limiter

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

geoStateIso('ontario', 'CA'); // "ON"
geoStateIso('ontario', 'US'); // undefined
geoStateIso('ontario', 'US', true); // throws a ZeroDepError

geoStateIso('w va', 'US'); // "WV"
geoStateIso('w va', 'CA'); // undefined
geoStateIso('w va', 'CA', true); // throws a ZeroDepError

Related Packages

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

• @zerodep/geo.countryiso - converts a country 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.

Resources

• Security Policy
• Changelog
• Contributing Guide
• Code of Conduct

License

MIT