Skip to the content

address-plusアドレスプラス

Parse, validate, format and compare addresses locally, add country modules and mount an optional native form field.

address-plus extends the parse-address style with typed results, validation, formatting and country modules. About the name

Contents

Reference · Australian country module

CountryComparisontype

What a country module's comparer returns: whether the two addresses are the same delivery point, and every field that differs once both are in the same form (letter case, punctuation, a street type written out or abbreviated).

Import it

import type { CountryComparison } from "@johnmorrisdotca/address-plus/au";

Also exported from: @johnmorrisdotca/address-plus/gb, @johnmorrisdotca/address-plus/de, @johnmorrisdotca/address-plus/fr, @johnmorrisdotca/address-plus

Definition

interface CountryComparison {
    isSame: boolean;
    differences: CountryDifference[];
}

Members

NameTypeDescription
isSameboolean
differencesCountryDifference[]

Examples

import { compareAustralianAddresses, parseAustralianAddress } from "@johnmorrisdotca/address-plus/au";
import type { CountryComparison } from "@johnmorrisdotca/address-plus/au";

const parsedAddress1=parseAustralianAddress("3/12 Smith Street, Parramatta NSW 2150");
if (!parsedAddress1) throw new Error("The example address did not parse.");
const parsedAddress2=parseAustralianAddress("Unit 3, 12 Smith St, PARRAMATTA NSW 2150");
if (!parsedAddress2) throw new Error("The example address did not parse.");
console.log(compareAustralianAddresses(parsedAddress1, parsedAddress2).isSame);
// → true
true

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/address-plus 1.7.0.