本文へ移動

address-plusアドレスプラス

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

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

目次

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

AddressComparisonResult型

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

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

インポート

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

定義

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

メンバー

名前型説明
isSameboolean
matchTypeAddressMatchType
similarityAddressSimilarityResult
normalizedAddress1ParsedAddress
normalizedAddress2ParsedAddress

例

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

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

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

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