本文へ移動

address-plusアドレスプラス

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

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

目次

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

JapaneseValidation型

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

What validateJapaneseAddress returns: the errors and the warnings found.

インポート

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

ほかのエクスポート元: @johnmorrisdotca/address-plus

定義

interface JapaneseValidation {
    errors: ValidationError[];
    warnings: ValidationError[];
}

メンバー

名前型説明
errorsValidationError[]
warningsValidationError[]

例

import { validateJapaneseAddress } from "@johnmorrisdotca/address-plus/jp";
import { parseLocation } from "@johnmorrisdotca/address-plus";
import type { JapaneseValidation } from "@johnmorrisdotca/address-plus/jp";

const parsedAddress1=parseLocation("東京都大阪市北区梅田1-1");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(validateJapaneseAddress(parsedAddress1).warnings.map((one) => one.code));
// → ["MUNICIPALITY_PREFECTURE_MISMATCH"]
[ 'MUNICIPALITY_PREFECTURE_MISMATCH' ]

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

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

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