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

AddressSimilarityResulttype

How alike two addresses are: an overall score from 0 to 1, a score for each part, and the differences.

Import it

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

Definition

interface AddressSimilarityResult {
    score: number;
    isMatch: boolean;
    confidence: number;
    details: {
        streetScore: number;
        cityScore: number;
        stateScore: number;
        postalScore: number;
        overallScore: number;
    };
    differences: AddressDifference[];
    suggestions?: string[];
}

Members

NameTypeDescription
scorenumber
isMatchboolean
confidencenumber
details{ streetScore: number; cityScore: number; stateScore: number; postalScore: number; overallScore: number; }
differencesAddressDifference[]
suggestions (optional)string[] | undefined

Examples

import { getAddressSimilarity, parseLocation } from "@johnmorrisdotca/address-plus";
import type { AddressSimilarityResult } 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(getAddressSimilarity(parsedAddress1, parsedAddress2).score);
// → 1
1

What it prints (run when this page was built)

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