ericpkerr / usps-abbreviations

USPS Abbreviations

USPS Abbreviations

Simple utility to transform USPS abbreviations to their full form.

Abbreviations from http://www.gis.co.clay.mn.us/usps.htm

Usage

var USPS = require('usps-abbreviations');

var transformed = USPS.transformText("123 N Main St, Chicago, IL 60610");
// 123 North Main Street, Chicago, Illinois 60610

Options

USPS.transformText(text, {
  // Shift the input case to upper to match abbreviations (recommended)
  shiftInputCase: true,

  // Shift the output result to capitalized words
  shiftOutputCase: true,

  // List of abbreviations to ignore (example ['PARK'])
  ignoreAbbreviations: [],

  // Remove all punctuation from output
  stripPunctuation: false,

  //Don't replace if punctuation is only a period and not last word in text
  skipMiddleEndingPeriod: true

  // Don't replace if punctuation is a period and last word in text
  skipFinalEndingPeriod: false
})