本文へ移動

address-plusアドレスプラス

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

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

目次

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

CountryValidation型

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

What a country module's validator returns: the errors and the warnings it found.

インポート

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

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

定義

interface CountryValidation {
    errors: ValidationError[];
    warnings: ValidationError[];
}

メンバー

名前型説明
errorsValidationError[]
warningsValidationError[]

例

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

const parsedAddress1=parseAustralianAddress("1 Main St, Sydney VIC 2000");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(validateAustralianAddress(parsedAddress1).warnings.map((one) => one.code));
// → ["POSTAL_REGION_MISMATCH"]
[ 'POSTAL_REGION_MISMATCH' ]

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

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

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