1.0.0 • Published 10 years ago

datasets-us-states-names-abbr v1.0.0

Weekly downloads
501
License
MIT
Repository
github
Last release
10 years ago

US State Names and Abbreviations

NPM version Build Status Coverage Status Dependencies

Maps US state names to state abbreviations.

Installation

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

For use in the browser, use browserify.

Usage

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

table

Maps US state names to state abbreviations.

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

Examples

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,

$ 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.

Copyright

Copyright © 2015. The Compute.io Authors.