リファレンス · 解析・書式・共通の型

AddressSimilarityResult型

リファレンスの説明と例は英語です。見出しと目次は日本語です。

インポート

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

定義

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

メンバー

例

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

出力（このページを作ったときに実行した結果）

ソースを見るGitHub で編集@johnmorrisdotca/address-plus 1.7.0 のソースから作成しました。

この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。