us - npm explorer

javascript-us
=============

NPM module of US state metadata. Heavily based on python-us

* all US states and territories
* postal abbreviations
* Associated Press style abbreviations
* FIPS codes
* capitals
* years of statehood
* time zones
* phonetic state name lookup
* URLs to shapefiles for state, census, congressional districts,
counties, and census tracts

Installation
------------

As per usual:

$ npm install us

Features
--------

Easy access to state information:

> var us = require('us')
> us.states.MD
{ name: 'Maryland',
metaphones: [ 'MRLNT' ],
statehood_year: 1788,
ap_abbr: 'Md.',
is_territory: false,
fips: '24',
abbr: 'MD',
capital: 'Annapolis',
capital_tz: 'America/New_York',
time_zones: [ 'America/New_York' ] }
> us.states.MD.fips
'24'
> us.states.MD.name
'Maryland'
>

Includes territories too:

> us.states.VI.name
'Virgin Islands'
> us.states.VI.is_territory
true
> us.states.MD.is_territory
false
>

List of all (actual) states:

> us.STATES
{ name: 'Alabama',
... },
{ name: 'Alaska',
... }, ...
> us.TERRITORIES
[ { name: 'American Samoa',
... },
{ name: 'Guam',
... }, ...

And the whole shebang, if you want it:

> us.STATES_AND_TERRITORIES
[ { name: 'Alabama',
... },
{ name: 'Alaska',
... }, ...
{ name: 'American Samoa',
... }, ...

The lookup method allows matching by FIPS code, abbreviation, and name:

> us.lookup('24')
{ name: 'Maryland',
... }
> us.lookup('MD')
{ name: 'Maryland',
... }
> us.lookup('md')
{ name: 'Maryland',
... }
> us.lookup('maryland')
{ name: 'Maryland',
... }
>

And for those days that you just can't remember how to spell Mississippi,
we've got phonetic name matching too: ::

> us.lookup('misisipi')
{ name: 'Mississippi'
... }

Shapefiles
----------

You want shapefiles too? Gotcha covered.