本文へ移動

address-plusアドレスプラス

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

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

目次

リファレンス · 英国のモジュール

validateUKAddress関数

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

Checks an address in the United Kingdom against Royal Mail's postcode grammar and the tables: the postcode is well formed, Royal Mail uses its area, and in Great Britain Code-Point Open lists its district. Says when a postcode is Jersey's, Guernsey's or the Isle of Man's, which are not part of the UK, and warns when the postcode or the post town is missing.

インポート

import { validateUKAddress } from "@johnmorrisdotca/address-plus/gb";

定義

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

引数

名前型説明
addressParsedAddress

The address as parseUKAddress (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 { parseUKAddress, validateUKAddress } from "@johnmorrisdotca/address-plus/gb";

const parsedAddress1=parseUKAddress("1 High Street, London EC9Z 1AA");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(validateUKAddress(parsedAddress1).warnings.map((one) => one.code));
// → ["INVALID_POSTAL_FORMAT"]
[ 'INVALID_POSTAL_FORMAT' ]

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

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

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