本文へ移動

address-plusアドレスプラス

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

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

目次

リファレンス · 解析・書式・共通の型

ParsedIntersection型

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

What parseIntersection returns: two streets, each with its name, type and directionals, and the place.

インポート

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

定義

interface ParsedIntersection {
    street1?: string;
    type1?: string;
    prefix1?: string;
    suffix1?: string;
    street2?: string;
    type2?: string;
    prefix2?: string;
    suffix2?: string;
    city?: string;
    state?: string;
    zip?: string;
    plus4?: string;
    country?: "CA" | "US";
    postalValid?: boolean;
    postalType?: "zip" | "postal";
}

メンバー

名前型説明
street1 (省略可)string | undefined
type1 (省略可)string | undefined
prefix1 (省略可)string | undefined
suffix1 (省略可)string | undefined
street2 (省略可)string | undefined
type2 (省略可)string | undefined
prefix2 (省略可)string | undefined
suffix2 (省略可)string | undefined
city (省略可)string | undefined
state (省略可)string | undefined
zip (省略可)string | undefined
plus4 (省略可)string | undefined
country (省略可)"CA" | "US" | undefined
postalValid (省略可)boolean | undefined
postalType (省略可)"zip" | "postal" | undefined

例

import { parseIntersection } from "@johnmorrisdotca/address-plus";
import type { ParsedIntersection } from "@johnmorrisdotca/address-plus";

console.log(parseIntersection("Hollywood Blvd and Vine St, Los Angeles, CA"));
// → {"state":"CA","city":"Los Angeles","street1":"Hollywood","type1":"Blvd","street2":"Vine","type2":"St"}
{
  state: 'CA',
  city: 'Los Angeles',
  street1: 'Hollywood',
  type1: 'Blvd',
  street2: 'Vine',
  type2: 'St'
}

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

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

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