本文へ移動

address-plusアドレスプラス

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

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

目次

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

FormattedAddress型

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

A formatted address: its lines, and the same on one line.

インポート

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

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

定義

interface FormattedAddress {
    lines: string[];
    singleLine: string;
    deliveryLine?: string;
    lastLine?: string;
    country?: string;
    format: "standard" | "usps" | "canada-post" | "international" | "australia-post" | "royal-mail" | "la-poste" | "deutsche-post";
}

メンバー

名前型説明
linesstring[]
singleLinestring
deliveryLine (省略可)string | undefined
lastLine (省略可)string | undefined
country (省略可)string | undefined
format"standard" | "usps" | "canada-post" | "international" | "australia-post" | "royal-mail" | "la-poste" | "deutsche-post"

例

import { formatUSPS, parseLocation } from "@johnmorrisdotca/address-plus";
import type { FormattedAddress } from "@johnmorrisdotca/address-plus/au";

const parsedAddress1=parseLocation("123 Main St, Anytown, NY 12345");
if (!parsedAddress1) throw new Error("The example address did not parse.");
console.log(formatUSPS(parsedAddress1));
// → {"lines":["123 MAIN ST","ANYTOWN NY 12345"],"singleLine":"123 Main St, Anytown NY 12345","deliveryLine":"123 Main St","lastLine":"Anytown NY 12345","country":"US","format":"usps"}
{
  lines: [ '123 MAIN ST', 'ANYTOWN NY 12345' ],
  singleLine: '123 Main St, Anytown NY 12345',
  deliveryLine: '123 Main St',
  lastLine: 'Anytown NY 12345',
  country: 'US',
  format: 'usps'
}

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

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

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