usps-webtools-promise

About:

This package was forked from MadisonReed/usps-webtools, but it has been modernized with Typescript and Promises (async/await). Note: Version 2 is a drop-in replacement for MadisonReed/usps-webtools, it produces the same output. Version 3 uses the same output from USPS, with the exception of Address1 and Address2 being switched, per social norms.

Installation:

npm install usps-webtools-promise

Usage:

Initializing the usps model with a user id.

Example:

const USPS = require('usps-webtools-promise').default;
// or
import USPS from "usps-webtools-promise";

const usps = new USPS({
  // USPS returns ALL CAPS, this boolean turns on Proper Caps for both Street lines and City. This is an optional item. Defaults to true.
  properCase: boolean,
  // Staging will run all functions on the USPS Staging servers instead of Production. Defaults to false.
  staging: boolean,
  // This can be created by going to https://www.usps.com/business/web-tools-apis/ and registering for an id
  userId: 'USPS User id',
});

verify(object)

Verify takes one parameter: object

object: Address1, Address2, City, State, Zip

Example

usps.verify({
  Address1: '322 3rd st.',
  Address2: 'Apt 2',
  City: 'San Francisco',
  State: 'CA',
  Zip5: '94103'
}).then(address => {
  console.log(address);
});

zipCodeLookup(object)

zipCodeLookup takes one parameter: object.

object: Address1, Address2, City, State

Example

const address = await usps.zipCodeLookup({
  Address1: '322 3rd st.',
  Address2: 'Apt 2',
  City: 'San Francisco',
  State: 'CA'
});

console.log(address);

cityStateLookup(object)

cityStateLookup takes one parameter: zipcode.

zipcode: 5 digit Zip Code as a string

Example

const result = await usps.cityStateLookup('94107');
console.log(result);

Coverage

-------------------------|---------|----------|---------|---------|-----------------------------
File                     | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-------------------------|---------|----------|---------|---------|-----------------------------
All files                |   83.91 |    57.97 |    92.3 |   83.91 |
 dist                    |    94.8 |    43.47 |     100 |    94.8 |
  address-validate.ts    |   96.22 |    38.88 |     100 |   96.22 | 94
  usps.ts                |   91.66 |       60 |     100 |   91.66 | 36
 dist/lookups            |   68.26 |       60 |   83.33 |   68.26 |
  city-state-lookup.ts   |   92.85 |    66.66 |     100 |   92.85 | 44
  pricing-rate-lookup.ts |   19.44 |    66.66 |      50 |   19.44 | 111-148
  zip-code-lookup.ts     |      95 |    53.84 |     100 |      95 | 68
 dist/utils              |   91.42 |    71.42 |     100 |   91.42 |
  proper-case.ts         |     100 |      100 |     100 |     100 |
  request.ts             |   86.95 |       60 |     100 |   86.95 | 47-48,55,114-115,119-120,153
-------------------------|---------|----------|---------|---------|-----------------------------