本文へ移動

address-plusアドレスプラス

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

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

目次

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

AddressComparisonTestCase型

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

A comparison case in the package's JSON test files: two addresses and the match expected.

インポート

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

定義

interface AddressComparisonTestCase extends TestCaseBase {
    input: {
        address1: string;
        address2: string;
    };
    expected: {
        isSame?: boolean;
        similarity?: number;
        differences?: string[];
        [key: string]: unknown;
    };
}

メンバー

名前型説明
input{ address1: string; address2: string; }
expected{ [key: string]: unknown; isSame?: boolean; similarity?: number; differences?: string[]; }
name (省略可)string | undefined
description (省略可)string | undefined
options (省略可)Record<string, unknown> | undefined

例

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

console.log(({ input: ["123 Main St", "123 Main Street"], expected: { isSame: true } }).expected.isSame);
// → true
true

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

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

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