本文へ移動

address-plusアドレスプラス

住所を端末の中で解析・確認・整形・比較し、国のモジュールや任意のフォームの入力欄を使えます。

address-plusは、parse-addressの使い方を広げ、型付きの結果、確認、書式、国のモジュールを加えます。 名前について(英語)

目次

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

getAddressSimilarity関数

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

The similarity of two parsed addresses, part by part, without a verdict: the score and each part's score, and the differences.

インポート

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

定義

function getAddressSimilarity(address1: ParsedAddress, address2: ParsedAddress, options?: AddressComparisonOptions): AddressSimilarityResult

引数

名前型説明
address1ParsedAddress

The first address, as parseLocation returns it.

address2ParsedAddress

The second address.

options (省略可)AddressComparisonOptions

How to compare (see AddressComparisonOptions).

戻り値

AddressSimilarityResult

The overall score from 0 to 1, the street, city, state and postal scores, and each difference with its kind.

例

import { getAddressSimilarity, parseLocation } from "@johnmorrisdotca/address-plus";

const parsedAddress1=parseLocation("123 Main Street, Anytown, NY 12345");
if (!parsedAddress1) throw new Error("The example address did not parse.");
const parsedAddress2=parseLocation("125 Main Street, Anytown, NY 12345");
if (!parsedAddress2) throw new Error("The example address did not parse.");
console.log(getAddressSimilarity(parsedAddress1, parsedAddress2).differences);
// → [{"field":"number","value1":"123","value2":"125","type":"typo","confidence":0.6}]
[
  {
    field: 'number',
    value1: '123',
    value2: '125',
    type: 'typo',
    confidence: 0.6
  }
]

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

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

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