本文へ移動

address-plusアドレスプラス

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

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

目次

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

parseJapaneseAddress関数

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

Parses a Japanese address, in Japanese script or in romaji, into the Japanese fields and the shared ones. parseLocation calls it for any address that looks Japanese; call it directly to skip the detection.

インポート

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

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

定義

function parseJapaneseAddress(text: string, options?: ParseOptions): ParsedAddress | null

引数

名前型説明
textstring

The address as one string, in either script, with or without 〒 and the postal code.

options (省略可)ParseOptions

useSnakeCase gives snake_case keys; the other options are ignored.

戻り値

ParsedAddress | null

The parts found, or null when nothing in the text names a place in Japan (no prefecture, municipality or postal code).

例

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

console.log(parseJapaneseAddress("〒100-0005 東京都千代田区丸の内1丁目2番3号 サンプルビル5階501号室")?.block);
// → "1-2-3"
1-2-3

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

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

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