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

CountryDifferencetype

One way two addresses differ, as a country module's comparer reports it: the field, and its value in each address after both were put in the same form.

Import it

import type { CountryDifference } 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 CountryDifference {
    field: string;
    first?: string;
    second?: string;
}

Members

NameTypeDescription
fieldstring
first (optional)string | undefined
second (optional)string | undefined

Examples

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

const parsedAddress1=parseUKAddress("10 High Street, Bath BA1 1AA");
if (!parsedAddress1) throw new Error("The example address did not parse.");
const parsedAddress2=parseUKAddress("12 High St, Bath BA1 1AA");
if (!parsedAddress2) throw new Error("The example address did not parse.");
console.log(compareUKAddresses(parsedAddress1, parsedAddress2).differences);
// → [{"field":"number","first":"10","second":"12"}]
[ { field: 'number', first: '10', second: '12' } ]

What it prints (run when this page was built)

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