ValidationOptions型
リファレンスの説明と例は英語です。見出しと目次は日本語です。
Options for the validators: which parts an address must have, which kinds are allowed, and whether a postal code that does not match its region is an error.
インポート
import type { ValidationOptions } from "@johnmorrisdotca/address-plus/jp";ほかのエクスポート元: @johnmorrisdotca/address-plus/au, @johnmorrisdotca/address-plus/gb, @johnmorrisdotca/address-plus/de, @johnmorrisdotca/address-plus/fr, @johnmorrisdotca/address-plus
定義
interface ValidationOptions {
requireStreetNumber?: boolean;
requireStreetName?: boolean;
requireCity?: boolean;
requireState?: boolean;
requirePostalCode?: boolean;
allowPOBox?: boolean;
allowRuralRoute?: boolean;
allowGeneralDelivery?: boolean;
strictPostalValidation?: boolean;
country?: ParseOptions["country"];
countries?: readonly import("./country-module").CountryModule[];
}メンバー
| 名前 | 型 | 説明 |
|---|---|---|
requireStreetNumber (省略可) | boolean | undefined | |
requireStreetName (省略可) | boolean | undefined | |
requireCity (省略可) | boolean | undefined | |
requireState (省略可) | boolean | undefined | |
requirePostalCode (省略可) | boolean | undefined | |
allowPOBox (省略可) | boolean | undefined | |
allowRuralRoute (省略可) | boolean | undefined | |
allowGeneralDelivery (省略可) | boolean | undefined | |
strictPostalValidation (省略可) | boolean | undefined | |
country (省略可) | "CA" | "US" | "JP" | "AU" | "GB" | "GY" | "IM" | "JE" | FrenchPostalCountry | "DE" | "GP" | "MQ" | "GF" | "RE" | "YT" | "auto" | undefined | |
countries (省略可) | readonly CountryModule[] | undefined |
例
import { validateAddress } from "@johnmorrisdotca/address-plus";
import type { ValidationOptions } from "@johnmorrisdotca/address-plus/jp";
console.log(validateAddress("123 Main St", { requirePostalCode: true }).errors.map((error) => error.code));
// → ["MISSING_POSTAL_CODE"][ 'MISSING_POSTAL_CODE' ]出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。