JSPM

us-street-abbreviations

1.0.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 73
  • Score
    100M100P100Q80917F
  • License ISC

Substitutes full words in U.S. street addresses with their postal short code abbreviations.

Package Exports

  • us-street-abbreviations

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (us-street-abbreviations) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

US Street Abbreviations

Turns a US street address into a unique set of strings with various standard US postal street keywords abbreviated.

Installation:

npm install --save us-street-abbrevations

Usage:

const X = import * from 'us-street-abbreviations';
X.getVariants('123 North Northeast Street');

Set DEBUG environment variable to true to enable debugging messages.

Expected result:

{
  '123 north northeast street',
  '123 n northeast street',
  '123 n ne street',
  '123 n ne st',
  '123 north ne street',
  '123 north ne st',
  '123 north northeast st',
}

TODO:

  • Allow for expansions (exchange w/arrays swapped)
  • Write tests