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 · British country module

compareUKAddressesfunction

Compares two addresses in the United Kingdom field by field: the flat, the building, the number, the thoroughfare, the post town and the postcode. Letter case, punctuation, a descriptor abbreviated (St, Rd) and the postcode's space are not differences. The localities and the county are left out, since Royal Mail needs neither when the postcode is given.

Import it

import { compareUKAddresses } from "@johnmorrisdotca/address-plus/gb";

Definition

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

Parameters

NameTypeDescription
firstParsedAddress

The first address, as parseUKAddress returns it.

secondParsedAddress

The second address.

Returns

CountryComparison

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

Examples

import { compareUKAddresses, parseUKAddress } from "@johnmorrisdotca/address-plus/gb";

const parsedAddress1=parseUKAddress("10 Downing Street, London SW1A 2AA");
if (!parsedAddress1) throw new Error("The example address did not parse.");
const parsedAddress2=parseUKAddress("10 DOWNING ST, LONDON, SW1A2AA");
if (!parsedAddress2) throw new Error("The example address did not parse.");
console.log(compareUKAddresses(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.