convert-region

A simple utility to convert region abbreviations to full names and vice-versa. Built with Typescript, and incredibly small.

Story

I found myself building an application with location data being return from an existing API as abbreviations but, for presentation's sake, I needed full state names. I ended up writing a utility locally within my project, and ultimately decided to publish. Check out my website if you want.

Usage

To use, install the package:

PNPM (recommended)

pnpm add convert-region

NPM

npm install convert-region

Yarn

yarn add convert-region

Then import it into your project:

import { convertRegion } from 'convert-region';

toFullName

To convert an abbreviation to a full name pass in an abbreviation from the list below:

convertRegion.toFullName('NY'); // New York

which will return New York.

toAbbreviation

To convert a full name to an abbreviation pass in an name from the list below:

convertRegion.toAbbreviation('New York'); // NY

which will return NY.

Currently Available Regions

This utility currently covers all of North America; more regions will be added in the future.

United States

Canada

Mexico