本文へ移動

address-plusアドレスプラス

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

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

目次

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

AustraliaPostFormattingOptions型

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

Options for formatAustraliaPost.

インポート

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

定義

interface AustraliaPostFormattingOptions {
    unitStyle?: "words" | "slash";
    wideSpacing?: boolean;
    includeCountry?: boolean;
}

メンバー

名前型説明
unitStyle (省略可)"words" | "slash" | undefined
wideSpacing (省略可)boolean | undefined
includeCountry (省略可)boolean | undefined

例

import { formatAustraliaPost, parseAustralianAddress } from "@johnmorrisdotca/address-plus/au";
import type { AustraliaPostFormattingOptions } from "@johnmorrisdotca/address-plus/au";

const parsedAddress1=parseAustralianAddress("Unit 3, 12 Smith St, Parramatta NSW 2150");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatAustraliaPost(parsedAddress1, { unitStyle: "slash" }).lines);
// → ["3/12 SMITH ST","PARRAMATTA NSW 2150"]
[ '3/12 SMITH ST', 'PARRAMATTA NSW 2150' ]

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

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

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