本文へ移動

address-plusアドレスプラス

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

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

目次

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

AddressParser型

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

The shape of the default export: the four parsers parse-address's users call on one object.

インポート

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

定義

interface AddressParser {
    parseAddress(address: string, options?: ParseOptions): ParsedAddress | null;
    parseInformalAddress(address: string, options?: ParseOptions): ParsedAddress | null;
    parseIntersection(address: string, options?: ParseOptions): ParsedIntersection | null;
    parseLocation(address: string, options?: ParseOptions): ParsedAddress | null;
}

メンバー

名前型説明
parseAddress(address: string, options?: ParseOptions): ParsedAddress | null
parseInformalAddress(address: string, options?: ParseOptions): ParsedAddress | null
parseIntersection(address: string, options?: ParseOptions): ParsedIntersection | null
parseLocation(address: string, options?: ParseOptions): ParsedAddress | null

例

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

console.log(Object.keys(parser));
// → ["parseLocation","parseIntersection","parseInformalAddress","parseAddress"]
[
  'parseLocation',
  'parseIntersection',
  'parseInformalAddress',
  'parseAddress'
]

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

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

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