本文へ移動

address-plusアドレスプラス

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

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

目次

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

getValidationErrors関数

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

The errors validateAddress finds, without the rest of its result.

インポート

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

定義

function getValidationErrors(addressString: string, options?: ValidationOptions): ValidationError[]

引数

名前型説明
addressStringstring

The address as one string.

options (省略可)ValidationOptions

What to require and how strict to be (see ValidationOptions).

戻り値

ValidationError[]

The errors, each with its field, code and message; an empty array when there are none.

例

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

console.log(getValidationErrors("123 Main St, Seattle, NY 98101", { strictPostalValidation: true }).map((error) => error.code));
// → ["POSTAL_REGION_MISMATCH"]
[ 'POSTAL_REGION_MISMATCH' ]

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

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

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