# address-plus アドレスプラス — US and Canadian address parser

> address-plus アドレスプラス — US and Canadian address parser: parse, validate, format and compare addresses, with Japanese support and modules for Australia, France, Germany and the UK. TypeScript, batch tools and an optional form field.

Install with `npm install @johnmorrisdotca/address-plus`. Every page below is also an HTML page at the same address ending in .html; the documentation's home is https://johnmorrisdotca.github.io/address-plus/docs/. The examples on the reference pages are run when the site is built, and what they print is shown under them.

## Guides

- [Getting started](https://johnmorrisdotca.github.io/address-plus/docs/guides/getting-started.md): Parse locally and inspect a nullable result.
- [Choose parsing rules](https://johnmorrisdotca.github.io/address-plus/docs/guides/parsing.md): Select a country and preserve the native field names.
- [Add country modules](https://johnmorrisdotca.github.io/address-plus/docs/guides/country-modules.md): Import only the optional country tables your host needs.
- [Look up postal regions](https://johnmorrisdotca.github.io/address-plus/docs/guides/postal-lookups.md): Distinguish syntax, known data and region membership.
- [Validate with findings](https://johnmorrisdotca.github.io/address-plus/docs/guides/validation.md): Keep errors and warnings visible without promising delivery.
- [Format native postal lines](https://johnmorrisdotca.github.io/address-plus/docs/guides/formatting.md): Use country-specific formats after a successful parse.
- [Compare and clean addresses](https://johnmorrisdotca.github.io/address-plus/docs/guides/comparing-and-cleaning.md): Separate normalized similarity from delivery identity.
- [Parse lists and save results](https://johnmorrisdotca.github.io/address-plus/docs/guides/batch-and-downloads.md): Keep result order, failed rows and local export formats.
- [Use the native form field](https://johnmorrisdotca.github.io/address-plus/docs/guides/form-field-and-embeds.md): Keep native form behavior and private values out of setup messages.
- [Architecture and generated data](https://johnmorrisdotca.github.io/address-plus/docs/guides/architecture.md): Keep country isolation, authoritative writers and checks together.
- [Troubleshooting and FAQ](https://johnmorrisdotca.github.io/address-plus/docs/guides/troubleshooting.md): Interpret missing results, country selection and form validity.
- [Upgrading from parse-address](https://johnmorrisdotca.github.io/address-plus/docs/guides/upgrading.md): Adopt the docs site while keeping existing parser contracts.

## Reference

- [@johnmorrisdotca/address-plus/jp](https://johnmorrisdotca.github.io/address-plus/docs/api/jp/index.md): Japanese addresses
- [@johnmorrisdotca/address-plus/au](https://johnmorrisdotca.github.io/address-plus/docs/api/au/index.md): Australian country module
- [@johnmorrisdotca/address-plus/gb](https://johnmorrisdotca.github.io/address-plus/docs/api/gb/index.md): British country module
- [@johnmorrisdotca/address-plus/de](https://johnmorrisdotca.github.io/address-plus/docs/api/de/index.md): German country module
- [@johnmorrisdotca/address-plus/fr](https://johnmorrisdotca.github.io/address-plus/docs/api/fr/index.md): French country module
- [@johnmorrisdotca/address-plus/element](https://johnmorrisdotca.github.io/address-plus/docs/api/element/index.md): Form-associated address field
- [@johnmorrisdotca/address-plus/element/define](https://johnmorrisdotca.github.io/address-plus/docs/api/element-define/index.md): Register the address field
- [@johnmorrisdotca/address-plus](https://johnmorrisdotca.github.io/address-plus/docs/api/main/index.md): Parsing, formatting and shared types

## Optional

- [Changelog](https://johnmorrisdotca.github.io/address-plus/docs/changelog.md): every release
- [Every export, in full](https://johnmorrisdotca.github.io/address-plus/llms-full.txt)
- [Source](https://github.com/johnmorrisdotca/address-plus)