本文へ移動

address-plusアドレスプラス

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

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

目次

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

findMunicipalitiesByName関数

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

The municipalities a Japanese name could mean: several when the name is shared (府中市 is in Tokyo and in Hiroshima). A town or village may be named without its district (当別町).

インポート

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

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

定義

function findMunicipalitiesByName(name: string, prefectureCode?: string): JapaneseMunicipality[]

引数

名前型説明
namestring

The municipality's name in Japanese.

prefectureCode (省略可)string | undefined

A prefecture's JIS code, to look in that prefecture only.

戻り値

JapaneseMunicipality[]

Every match, an empty array when there is none.

例

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

console.log(findMunicipalitiesByName("府中市").map((one) => one.code + " " + one.romaji));
// → ["13206 Fuchu-shi","34208 Fuchu-shi"]
[ '13206 Fuchu-shi', '34208 Fuchu-shi' ]

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

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

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