本文へ移動

address-plusアドレスプラス

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

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

目次

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

australia定数

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

Australia's module, for parseLocation and validateAddress: pass it in countries, and an address that ends with a state and its postcode (or Australia) is read as Australian; country: "AU" reads any address as one.

インポート

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

定義

const australia: CountryModule = {
    code: "AU",
    codes: ["AU"],
    name: "Australia",
    detect: looksAustralian,
    parse: parseAustralianAddress,
    validate: validateAustralianAddress,
    format: (address) => formatAustraliaPost(address),
    compare: compareAustralianAddresses,
}

メンバー

名前型説明
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 { parseLocation } from "@johnmorrisdotca/address-plus";
import { australia } from "@johnmorrisdotca/address-plus/au";

console.log(parseLocation("3/12 Smith St, Parramatta NSW 2150", { countries: [australia] })?.secUnitNum);
// → "3"
3

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

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

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