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

PostalValidationResult型

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

インポート

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

定義

interface PostalValidationResult {
    isValid: boolean;
    type: "zip" | "postal" | null;
    formatted?: string;
    message?: string;
}

メンバー

例

import { validatePostalCode } from "@johnmorrisdotca/address-plus";
import type { PostalValidationResult } from "@johnmorrisdotca/address-plus";

console.log(validatePostalCode("98101"));
// → {"isValid":true,"type":"zip","formatted":"98101","message":"Valid US ZIP code format"}

{
  isValid: true,
  type: 'zip',
  formatted: '98101',
  message: 'Valid US ZIP code format'
}

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

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

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