本文へ移動

address-plusアドレスプラス

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

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

目次

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

compareAddresses関数

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

Compares two parsed addresses field by field, allowing for abbreviations (Street and St), state names and codes, letter case and small typos.

インポート

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

定義

function compareAddresses(address1: ParsedAddress, address2: ParsedAddress, options?: AddressComparisonOptions): AddressComparisonResult

引数

名前型説明
address1ParsedAddress

The first address, as parseLocation returns it.

address2ParsedAddress

The second address.

options (省略可)AddressComparisonOptions

How to compare: which parts to ignore and how close a fuzzy match must be (see AddressComparisonOptions).

戻り値

AddressComparisonResult

Whether they are the same place, how strong the match is (exact to none), the similarity score from 0 to 1 and every difference found.

例

import { compareAddresses, 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("123 Main St, Anytown, New York 12345");
if (!parsedAddress2) throw new Error("The example address did not parse.");
console.log(compareAddresses(parsedAddress1, parsedAddress2).matchType);
// → "exact"
exact

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

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

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