Socket
Socket
Sign inDemoInstall

us-regions

Package Overview
Dependencies
0
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    us-regions

Lists of US and Canadian states and territories


Version published
Weekly downloads
308
decreased by-11.75%
Maintainers
1
Install size
12.6 kB
Created
Weekly downloads
 

Readme

Source

US Regions

Lists of states and territories in the US and Canada, and mappings to regions. Data sources:

Installation

npm install us-regions

Usage

var regions = require("us-regions");
  • regions.postalAbbr(name): Returns a postal abbreviation (e.g. "CA", "MT", "MA") for the given state or territory name or abbreviation (e.g. "calif", "Montana", "Mass."), or undefined if not found.
  • regions.normalize(name): Returns a normalized full name ("District of Columbia", "Newfoundland and Labrador", "Wyoming") for the given state or territory name or abbreviation ("DC", "Newfoundland", "wyo"), or undefined if not found.
  • regions.region(name): Returns a US geographic region for the given state or territory name or abbreviation. Regions: "Northeast", "Midwest", "South", "West".

Also includes several mappings for raw usage -- consult index.js for details:

  • regions.US_STATES_AND_TERRITORIES
  • regions.FIFTY_STATES
  • regions.CANADIAN_TERRITORIES
  • regions.US_AND_CANADA
  • regions.STATES_NORMALIZED
  • regions.US_REGIONS
  • regions.US_REGIONS_BY_STATE

Data sources:

FAQs

Last updated on 22 Apr 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc