本文へ移動

address-plusアドレスプラス

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

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

目次

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

isValidAddress関数

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

Whether an address passes validateAddress.

インポート

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

定義

function isValidAddress(addressString: string, options?: ValidationOptions): boolean

引数

名前型説明
addressStringstring

The address as one string.

options (省略可)ValidationOptions

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

戻り値

boolean

true when it has no errors, false otherwise. Warnings do not make it invalid unless strictPostalValidation turns them into errors.

例

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

console.log(isValidAddress("123 Main St, Seattle, NY 98101", { strictPostalValidation: true }));
// → false
false

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

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

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