本文へ移動

address-plusアドレスプラス

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

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

目次

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

parseAddress関数

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

Parses a street address. The same as parseLocation, kept under the name parse-address's users know.

インポート

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

定義

function parseAddress(address: string, options?: ParseOptions): ParsedAddress | null

引数

名前型説明
addressstring

The address as one string.

options (省略可)ParseOptions

How to parse (see ParseOptions).

戻り値

ParsedAddress | null

The parts found, or null when nothing can be read as an address.

例

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

console.log(parseAddress("123 Main St Apt 4, Anytown, NY 12345")?.secUnitNum);
// → "4"
4

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

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

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