本文へ移動

address-plusアドレスプラス

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

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

目次

リファレンス · 日本の住所

ValidationError型

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

One finding of a validator: the field it is about, its code, a message, and how serious it is.

インポート

import type { ValidationError } 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 ValidationError {
    field: string;
    code: string;
    message: string;
    severity: "error" | "warning" | "info";
}

メンバー

名前型説明
fieldstring
codestring
messagestring
severity"error" | "warning" | "info"

例

import { validateAddress } from "@johnmorrisdotca/address-plus";
import type { ValidationError } from "@johnmorrisdotca/address-plus/jp";

console.log(validateAddress("123 Main St, Seattle, NY 98101").warnings[0]);
// → {"field":"zip","code":"POSTAL_REGION_MISMATCH","message":"ZIP code 98101 belongs to WA, not NY","severity":"warning"}
{
  field: 'zip',
  code: 'POSTAL_REGION_MISMATCH',
  message: 'ZIP code 98101 belongs to WA, not NY',
  severity: 'warning'
}

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

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

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