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

ParsedAddress型

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

インポート

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

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

定義

interface ParsedAddress extends JapaneseAddressFields, AustralianAddressFields, FrenchAddressFields, UKAddressFields {
    city?: string;
    compartment?: string;
    country?: "CA" | "US" | "JP" | "AU" | "GB" | "GY" | "IM" | "JE" | FrenchPostalCountry | "DE";
    fraction?: string;
    generalDelivery?: boolean;
    highwayContract?: string;
    locality?: string;
    military?: string;
    number?: string;
    place?: string;
    plus4?: string;
    postalValid?: boolean;
    postalType?: "zip" | "postal";
    prefix?: string;
    rpo?: string;
    rr?: string;
    ruralRoute?: string;
    secUnitNum?: string;
    secUnitType?: string;
    secondary?: string;
    site?: string;
    state?: string;
    station?: string;
    street?: string;
    suffix?: string;
    type?: string;
    unit?: string;
    zip?: string;
    zipValid?: boolean;
}

メンバー

例

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

console.log(parseLocation("123 Main St Apt 4, Anytown, NY 12345"));
// → {"number":"123","secUnitType":"Apartment","secUnitNum":"4","unit":"Apt 4","street":"Main","type":"St","city":"Anytown","state":"NY","zip":"12345","zipValid":true,"country":"US"}

{
  number: '123',
  secUnitType: 'Apartment',
  secUnitNum: '4',
  unit: 'Apt 4',
  street: 'Main',
  type: 'St',
  city: 'Anytown',
  state: 'NY',
  zip: '12345',
  zipValid: true,
  country: 'US'
}

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

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

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