本文へ移動

address-plusアドレスプラス

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

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

目次

リファレンス · オーストラリアのモジュール

CountryModule型

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

A country's address module: its codes, how to tell its addresses apart, and its parser, validator, formatter and comparer. Import one from its entry point (australia from @johnmorrisdotca/address-plus/au, unitedKingdom from @johnmorrisdotca/address-plus/gb) and hand it to parseLocation and validateAddress in countries.

インポート

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

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

定義

interface CountryModule {
    code: string;
    codes: readonly string[];
    name: string;
    detect(address: string): boolean;
    parse(address: string, options?: ParseOptions): ParsedAddress | null;
    validate(address: ParsedAddress, options?: ValidationOptions): CountryValidation;
    format(address: ParsedAddress): FormattedAddress;
    compare(first: ParsedAddress, second: ParsedAddress): CountryComparison;
}

メンバー

名前型説明
codestring
codesreadonly string[]
namestring
detect(address: string): boolean
parse(address: string, options?: ParseOptions): ParsedAddress | null
validate(address: ParsedAddress, options?: ValidationOptions): CountryValidation
format(address: ParsedAddress): FormattedAddress
compare(first: ParsedAddress, second: ParsedAddress): CountryComparison

例

import { australia } from "@johnmorrisdotca/address-plus/au";
import type { CountryModule } from "@johnmorrisdotca/address-plus/au";

console.log(australia.codes);
// → ["AU"]
[ 'AU' ]

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

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

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