本文へ移動

address-plusアドレスプラス

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

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

目次

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

validateAustralianAddress関数

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

Checks an Australian address against Australia Post's blocks of postcodes: the postcode is four digits, some state's block holds it, and it is the state named, or one it serves across a border (from the ABS's Postal Areas). Also warns when the state, the postcode or the suburb is missing.

インポート

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

定義

function validateAustralianAddress(address: ParsedAddress, options?: ValidationOptions): CountryValidation

引数

名前型説明
addressParsedAddress

The address as parseAustralianAddress (or parseLocation with the module) returns it.

options (省略可)ValidationOptions

strictPostalValidation: true makes the postcode findings errors; the rest are not used.

戻り値

CountryValidation

The errors and warnings, each with its field, code and message.

例

import { parseAustralianAddress, validateAustralianAddress } 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[0].message);
// → "Postcode 2000 belongs to NSW, not VIC"
Postcode 2000 belongs to NSW, not VIC

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

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

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