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 · Parsing, formatting and shared types

AddressComparisonResulttype

What compareAddresses returns: the verdict, the match type and the similarity.

Import it

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

Definition

interface AddressComparisonResult {
    isSame: boolean;
    matchType: AddressMatchType;
    similarity: AddressSimilarityResult;
    normalizedAddress1: ParsedAddress;
    normalizedAddress2: ParsedAddress;
}

Members

NameTypeDescription
isSameboolean
matchTypeAddressMatchType
similarityAddressSimilarityResult
normalizedAddress1ParsedAddress
normalizedAddress2ParsedAddress

Examples

import { compareAddresses, parseLocation } from "@johnmorrisdotca/address-plus";
import type { AddressComparisonResult } from "@johnmorrisdotca/address-plus";

const parsedAddress1=parseLocation("123 Main St, Anytown, NY 12345");
if (!parsedAddress1) throw new Error("The example address did not parse.");
const parsedAddress2=parseLocation("123 Main Street, Anytown, NY 12345");
if (!parsedAddress2) throw new Error("The example address did not parse.");
console.log(compareAddresses(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.