本文へ移動

address-plusアドレスプラス

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

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

目次

リファレンス · オーストラリアのモジュール

CountryComparison型

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

What a country module's comparer returns: whether the two addresses are the same delivery point, and every field that differs once both are in the same form (letter case, punctuation, a street type written out or abbreviated).

インポート

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

ほかのエクスポート元: @johnmorrisdotca/address-plus/gb, @johnmorrisdotca/address-plus/de, @johnmorrisdotca/address-plus/fr, @johnmorrisdotca/address-plus

定義

interface CountryComparison {
    isSame: boolean;
    differences: CountryDifference[];
}

メンバー

名前型説明
isSameboolean
differencesCountryDifference[]

例

import { compareAustralianAddresses, parseAustralianAddress } from "@johnmorrisdotca/address-plus/au";
import type { CountryComparison } from "@johnmorrisdotca/address-plus/au";

const parsedAddress1=parseAustralianAddress("3/12 Smith Street, Parramatta NSW 2150");
if (!parsedAddress1) throw new Error("The example address did not parse.");
const parsedAddress2=parseAustralianAddress("Unit 3, 12 Smith St, PARRAMATTA NSW 2150");
if (!parsedAddress2) throw new Error("The example address did not parse.");
console.log(compareAustralianAddresses(parsedAddress1, parsedAddress2).isSame);
// → true
true

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

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

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