address-plus documentation
address-plus アドレスプラス — US and Canadian address parser
Parse, validate, format and compare addresses locally, add country modules and mount an optional native form field.
Install
npm install @johnmorrisdotca/address-plus
Start here
Entry points
| Import it | What it is | Size |
|---|---|---|
@johnmorrisdotca/Japanese addresses · 29 exports | 60.6 kB | |
@johnmorrisdotca/Australian country module · 30 exports | 7.2 kB | |
@johnmorrisdotca/British country module · 31 exports | 8.7 kB | |
@johnmorrisdotca/German country module · 31 exports | 12.2 kB | |
@johnmorrisdotca/French country module · 32 exports | 9.3 kB | |
@johnmorrisdotca/Form-associated address field · 6 exports | 133.0 kB | |
@johnmorrisdotca/Register the address field · 6 exports | 133.0 kB | |
@johnmorrisdotca/Parsing, formatting and shared types · 182 exports | 105.7 kB |
Guides
How-to
- Choose parsing rulesSelect a country and preserve the native field names.
- Add country modulesImport only the optional country tables your host needs.
- Look up postal regionsDistinguish syntax, known data and region membership.
- Validate with findingsKeep errors and warnings visible without promising delivery.
- Format native postal linesUse country-specific formats after a successful parse.
- Compare and clean addressesSeparate normalized similarity from delivery identity.
- Parse lists and save resultsKeep result order, failed rows and local export formats.
- Use the native form fieldKeep native form behavior and private values out of setup messages.