datasets-us-states-capitals-names

1.0.0 • Public • Published

US State Capitals and Names

NPM version Build Status Coverage Status Dependencies

Maps US state capitals to state names.

Installation

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

For use in the browser, use browserify.

Usage

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

table

Maps US state capitals to state names.

console.dir( table );
/*
    {
        "Montgomery": "Alabama",
        "Juneau": "Alaska",
        "Phoenix": "Arizona",
        "Little Rock": "Arkansas",
        "Sacramento": "California",
        ...
    }
*/

Examples

var table = require( 'datasets-us-states-capitals-names' );
 
function getState( capital ) {
    var state,
        parts,
        len,
        i;
 
    // Ensure the first letter of each word comprising a capital's name is capitalized...
    parts = capital.split( ' ' );
    len = parts.length;
    capital = '';
    for ( i = 0; i < len; i++ ) {
        capital += parts[ i ][ 0 ].toUpperCase() + parts[ i ].substring( 1 );
        if ( i < len-1 ) {
            capital += ' ';
        }
    }
    // Get the state name:
    state = table[ capital ];
 
    // Ensure a valid capital was provided...
    if ( state === void 0 ) {
        throw new Error( 'unrecognized capital. Value: `' + capital + '`.' );
    }
    return state;
}
 
console.log( getState( 'Jefferson City' ) );
console.log( getState( 'Trenton' ) );
console.log( getState( 'Sacramento' ) );

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.

Package Sidebar

Install

npm i datasets-us-states-capitals-names

Weekly Downloads

8

Version

1.0.0

License

MIT

Last publish

Collaborators

  • kgryte