datasets-us-states-names-abbr

US State Names and Abbreviations
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]

> Maps US state names to state abbreviations.

Installation

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

For use in the browser, use browserify.

Usage

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

#### table

Maps US state names to state abbreviations.

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

Examples

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

function getAbbr( state ) {
var parts,
abbr,
len,
i;

// Ensure the first letter of each word comprising a state name is capitalized...
parts = state.split( ' ' );
len = parts.length;
state = '';
for ( i = 0; i < len; i++ ) {
state += parts[ i ][ 0 ].toUpperCase() + parts[ i ].substring( 1 );
if ( i < len-1 ) {
state += ' ';
}
}
// Get the state abbreviation:
abbr = table[ state ];

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

console.log( getAbbr( 'Missouri' ) );
console.log( getAbbr( 'New Jersey' ) );
console.log( getAbbr( 'California' ) );
`

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

` bash
$ node ./examples/index.js
`

Tests

$3

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

` bash
$ make test
`

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

$3

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:

` bash
$ make test-cov
`

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

` bash
$ make view-cov
``

---

License

MIT license.

Copyright

Copyright © 2015. The Compute.io Authors.

[npm-image]: http://img.shields.io/npm/v/datasets-us-states-names-abbr.svg
[npm-url]: https://npmjs.org/package/datasets-us-states-names-abbr

[travis-image]: http://img.shields.io/travis/datasets-io/us-states-names-abbr/master.svg
[travis-url]: https://travis-ci.org/datasets-io/us-states-names-abbr

[codecov-image]: https://img.shields.io/codecov/c/github/datasets-io/us-states-names-abbr/master.svg
[codecov-url]: https://codecov.io/github/datasets-io/us-states-names-abbr?branch=master

[dependencies-image]: http://img.shields.io/david/datasets-io/us-states-names-abbr.svg
[dependencies-url]: https://david-dm.org/datasets-io/us-states-names-abbr

[dev-dependencies-image]: http://img.shields.io/david/dev/datasets-io/us-states-names-abbr.svg
[dev-dependencies-url]: https://david-dm.org/dev/datasets-io/us-states-names-abbr

[github-issues-image]: http://img.shields.io/github/issues/datasets-io/us-states-names-abbr.svg
[github-issues-url]: https://github.com/datasets-io/us-states-names-abbr/issues