npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

usa-states

v0.0.6

Published

Helper library for getting all of the states and territories of the United States in the specific format that you need.

Downloads

64,137

Readme

Usa States

A simple javascript library to aid with the creation of your custom array of US States.

Installation

npm install usa-states

Then include the library in your project with either

var UsaStates = require('usa-states').UsaStates;

or

<script src="/js/usa-states.js"></script>

Usage

To quickly get a simple array of US States objects

var usStates = new UsaStates();
console.log(usStates.states);

Outputs

{
    name: "Alabama",
    abbreviation: "AL",
    territory: false,
    capital: "Montgomery",
    contiguous: true
},
{
    name: "Alaska",
    abbreviation: "AK",
    territory: false,
    capital: "Juneau",
    contiguous: false
},
...(other states omitted for brevity)
{
    name: "Wyoming",
    abbreviation: "WY",
    territory: false,
    capital: "Cheyenne",
    contiguous: true
}

You can optionally filter or add to the list of US States

var lowerFourtyEight = new UsaStates({contiguousOnly: true});
console.log('Lower 48 states only', lowerFourtyEight.states);

var statesAndTerritories = new UsaStates({includeTerritories: true}); 
console.log('All states including territories', statesAndTerritories.states);

You can also manually exclude one or more using any of the alias selectors

var allStatesExceptDCandWY = new UsaStates({exclude: ['DC', 'Wyoming']});

You can get them as an array of strings using an alias selector (full list of alias selectors below)

var usStates = new UsaStates(myOptionalFilterSettings);
var statesAbbreviation = usStates.arrayOf('abbreviations');
var statesNames = usStates.arrayOf('names');
console.log(statesAbbreviation);
console.log(statesNames);

Outputs

["AL", "AK", ... , "WY"]
["Alabama", "Alaska", ..., "Wyoming"]

You can also get them as an array of custom objects using the alias selectors If you want an alias ignored just append a '$' character to the desired location (note: you can change this ignore character in your filter config, see below)

var usStates = new UsaStates(myOptionalFilterSettings);
var myCustomStates = usStates.format({
    name: 'abbreviation',
    $abbreviation: 'abbr', // alternate alias 'abbr', see all below
    abbr: '$name',
    $capital: 'c',
});
console.log(myCustomStates);

Outputs

{
    Alabama: "AL",
    abbreviation: "AL",
    AL: "name",
    capital: "Mobile"
},
{
    Alaska: "AK",
    abbreviation: "AK",
    AK: "name",
    capital: "Juneau"
},
...
{
    Wyoming: "WY",
    abbreviation: "WY",
    WY: "name",
    capital: "Cheyenne"
}

Configuration Settings

| Property Name | Default | Description | | ------------- |:-------:| ----------- | | contingousOnly | false | Filter out any state that is not in the lower 48. (note: this also filters out territories) | | includeTerritories | false | Includes territories and affiliates of the United States such as Puerto Rico, Virgin Islands, etc. | | exclude | [] | An array of one or more states to filter from your list of states using any of the alias selectors | | ignoreCharacter | "$" | The character to parse out if found appended inside of the custom format given |

Alias Selectors

| Name | Other Acceptable Aliases | Examples | ---- |:-----------------------:| ------- | abbreviation | a, abbr, abbreviations, | AL, AK, ... WY | name | names, state, states, n, s | Alabama, Alaska, ... Wyoming | | capital | c, cap, capitals | Mobile, Juneau, ... Cheyenne |

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Credits

Author: Nathan Barrett [email protected]

License

ISC License

Copyright 2017 Nathan Barrett

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.