@zerodep/address_parse

An address parser for American and Canadian addresses that breaks down the provided address into its component parts.

WARNING: THIS IS BETA SOFTWARE

The beta version focuses on accuracy over performance.

tl;dr

A short explanation / quick reference:

import { addressParse } from '@zerodep/address_parse';

const address = addressParse(
  '1600 Pennsylvania Avenue North West Office #100 Washington DC 20500'
);
// {
//   secondaryType: 'Ofc',
//   secondaryNumber: '100',
//   buildingNumber: '1600',
//   streetNamePre: 'PENNSYLVANIA',
//   streetType: 'AVE',
//   directionalPost: 'NW',
//   city: 'WASHINGTON',
//   state: 'DC',
//   zip: '20500',
//   country: 'US',
// }

const poBox = addressParse('Post office Box 3094 Collierville 38027');
// {
//   poBox: 'PO BOX 3094',
//   city: 'COLLIERVILLE',
//   state: 'TN',
//   zip: '38027',
//   country: 'US',
// }

Table of Contents

• Installation Instructions
• How to Use
  • Signature
• ZeroDep Advantages
• Support
• Semver
• Resources
• License

Install

npm install @zerodep/address_parse

Of course, you may use yarn, pnpm, or the package manager of your choice. Only npm examples are shown for brevity.

This package may also be found on both jsDelivr and unpkg in UMD, ESM and CJS formats.

How to Use

This package exports the following:

• Functions
  • addressParse - a function that parses a string into its determinable address components
• Interface
  • IAddress - a typescript interface of the components of an address
• Error types
  • ZeroDepError - thrown if the address cannot be parsed completely, is an instance of the base Error object

Signature

Typescript declarations:

interface IAddress {
  attn?: string;
  careOf?: string;
  pmb?: string;
  msc?: string;
  poBox?: string;
  rural?: string;
  highway?: string;
  military?: string;
  generalDelivery?: string;
  secondaryType?: string;
  secondaryNumber?: string;
  buildingNumber?: string;
  directionalPre?: string;
  streetNamePre?: string;
  streetType?: string;
  streetNamePost?: string;
  directionalPost?: string;
  city?: string;
  state?: string;
  zip?: string;
  zipExt?: string;
  country?: string;
}

interface IAddressOptions {
  city?: string;
  state?: string;
  country?: string;
  zip?: string;
}

declare const addressParse: (
  line: string,
  options?: IAddressOptions
) => IAddress;

Advantages of @zerodep Packages

We help make source code more readable, more secure, faster to craft, less likely to have hidden defects, and easier to maintain.

• Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
• Fully typed - typescript definitions are provided for every package for a better developer experience
• Semantically named - package and method names are easy to grok, remember, use, and read
• Documented - actually useful documentation with examples and helpful tips
• Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
• 100% Tested - all methods and packages are fully unit tested
• ESM & CJS - has both ecmascript modules and common javascript exports, both are fully tree-shakable
• CDN Available - available on fast content delivery networks in UMD, CJS and ESM formats
• FP Inspired - gently opinionated to encourage functional programming style for cleaner and more maintainable software
• Predictably Versioned - semantically versioned for peace-of-mind upgrading, this includes changelogs
• MIT Licensed - permissively licensed for maximum usability

Support

All @zerodep packages are built for the ES2020 specification. Should you need to support older environments you will need to add appropriate polyfills. All packages are tested on the following platforms/browsers:

Browsers

• Chrome - last 2 major versions
• Firefox - last 2 major versions
• Safari - last 2 major versions
• Edge - last 2 major versions
• Android - last 2 major versions
• iOS - last 2 major versions

Node

• v18.x - Hydrogen LTS
• v16.x - Gallium LTS

It is likely the package will work on other technologies and version, however development and testing effort is only spent on the above.

Semver

All @zerodep packages, including this one, adhere to Semantic Versioning practices:

• major versions: correlates with breaking changes to one or more method signatures
• minor versions: includes addition of new functionality or backwards-compatible software improvements
• patch versions: are reserved for copy changes, documentation enhancements and bug fixes

The above said, a security best practice is to pin your software packages to specific versions and only upgrade to more recent releases after careful inspection of any CHANGELOG, release notes and all software changes.

Resources

• Security Policy
• Changelog
• Contributing Guide
• Code of Conduct

License

MIT