US State Abbreviations and Names

Maps US state abbreviations to state names.

Installation

$ npm install datasets-us-states-abbr-names

For use in the browser, use browserify.

Usage

var table = require( 'datasets-us-states-abbr-names' );

table

Maps US state two-letter abbreviations to state names.

console.dir( table );
/*
    {
        "AL": "Alabama",
        "AK": "Alaska",
        "AZ": "Arizona",
        "AR": "Arkansas",
        "CA": "California",
        ...
    }
*/

Examples

var table = require( 'datasets-us-states-abbr-names' );

function getState( abbr ) {
    var state;

    // Ensure an abbreviation is capitalized...
    abbr.toUpperCase();

    // Get the state name:
    state = table[ abbr ];

    // Ensure a valid abbreviation was provided...
    if ( state === void 0 ) {
        throw new Error( 'unrecognized state abbreviation. Value: `' + abbr + '`.' );
    }
    return state;
}

console.log( getState( 'MO' ) );
console.log( getState( 'NJ' ) );
console.log( getState( 'CA' ) );

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

datasets-io / us-states-abbr-names

readme