本文へ移動

address-plusアドレスプラス

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

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

目次

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

AddressValidationTestCase型

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

A validation case in the package's JSON test files: an address and the verdict and codes expected.

インポート

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

定義

interface AddressValidationTestCase extends TestCaseBase {
    input: string;
    expected: {
        isValid: boolean;
        confidence?: number;
        completeness?: number;
        errors?: string[];
        warnings?: string[];
        [key: string]: unknown;
    };
}

メンバー

名前型説明
inputstring
expected{ [key: string]: unknown; isValid: boolean; confidence?: number; completeness?: number; errors?: string[]; warnings?: string[]; }
name (省略可)string | undefined
description (省略可)string | undefined
options (省略可)Record<string, unknown> | undefined

例

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

console.log(({ input: "123 Main St", expected: { isValid: false } }).expected.isValid);
// → false
false

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

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

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