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

compareAustralianAddressesfunction

Compares two Australian addresses field by field: the unit, level, lot, number, street, suburb, state and postcode. Letter case, punctuation, a street type written out or abbreviated (Street, St) and a state by name or code are not differences.

Import it

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

Definition

function compareAustralianAddresses(first: ParsedAddress, second: ParsedAddress): CountryComparison

Parameters

NameTypeDescription
firstParsedAddress

The first address, as parseAustralianAddress returns it.

secondParsedAddress

The second address.

Returns

CountryComparison

Whether they are the same delivery point, and each field that differs.

Examples

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

const parsedAddress1=parseAustralianAddress("12 Smith Street, Parramatta NSW 2150");
if (!parsedAddress1) throw new Error("The example address did not parse.");
const parsedAddress2=parseAustralianAddress("14 Smith St, Parramatta New South Wales 2150");
if (!parsedAddress2) throw new Error("The example address did not parse.");
console.log(compareAustralianAddresses(parsedAddress1, parsedAddress2));
// → {"isSame":false,"differences":[{"field":"number","first":"12","second":"14"}]}
{
  isSame: false,
  differences: [ { field: 'number', first: '12', second: '14' } ]
}

What it prints (run when this page was built)

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