@evokegroup/usps v1.0.1

@evokegroup/usps

Library for validating address information with USPS

UspsClient

constructor()

Methods

validateAddress()

returns Promise<ValidateResponse>

import { UpspClient } from '@evokegroup/usps';

const usps = new UspsClient('XXXXXXXXXX');
usps.validateAddress({
  address1: '123 Main St',
  city: 'Anytown',
  state: 'ST',
  zip5: '12345'
})
  .then((validateResponse) => {
    // do something
  })
  .catch((err) => {
    // handle error
  });

cityStateLookup()

returns Promise<Response>

import { UpspClient } from '@evokegroup/usps';

const usps = new UspsClient('XXXXXXXXXX');
usps.cityStateLookup('12345')
  .then((Response) => {
    // do something
  })
  .catch((err) => {
    // handle error
  });

zipCodeLookup()

returns Promise<Response>

import { UpspClient } from '@evokegroup/usps';

const usps = new UspsClient('XXXXXXXXXX');
usps.zipCodeLookup({
  address1: '123 Main St',
  city: 'Anytown',
  state: 'ST'
})
  .then((Response) => {
    // do something
  })
  .catch((err) => {
    // handle error
  });

Response

ValidateResponse

extends Response

Address

AddressMatch

Status

'FOUND' | 'ADDRESS_NOT_FOUND' | 'INVALID_CITY' | 'INVALID_STATE' | 'INVALID_ZIP_CODE' | 'ERROR'