PostalCode / 郵便番号ESモジュール

日本郵便株式会社のKEN_ALL.ZIPをデータソースとして使った、郵便番号データを地方公共団体コードと町名、町名のよみへ変換するESモジュールです。
This ES module converts Japanese zip codes to addresses. (Local government codes and town names.)

GitHub Actions scheduled-fetch.yml によって、毎日更新をチェックしています。

ブラウザ上での使用例

• ブラウザで開く 郵便番号から地方公共団体コードと町名変換

API (web / Deno)

import { PostalCode } from "https://code4fukui.github.io/PostalCode/PostalCode.js";

console.log(await PostalCode.decode(9160042));

出力

[{ zipcode: "9160042", lgcode: "18207", town: "新横江", townyomi: "シンヨコエ" }]

郵便番号（半角、ハイフン付き、空白付きOK！）を渡すと、該当する配列と正規化した郵便番号を返します。見つからない場合は長さ0の配列 [] を返します。
toplevel await 非対応のブラウザでは、async関数内で使用してください。

• 地方公共団体コードは、地方公共団体コード ESモジュールを使って都道府県と市区町村に変換できます

インストール

以下の手順でインストールしローカルでも使用できます。

$ github clone https://github.com/code4fukui/PostalCode.git

データ生成、データ更新

$ cd tools
$ sh makedata.sh

読み仮名データの促音・拗音を小書きで表記するもの - zip圧縮形式 日本郵便 を使用します

テスト

$ deno test -A

依存モジュール

• CSV.js

関連記事

• KEN_ALL!? 郵便番号ESモジュールで開発効率化！ 経産省もGitHub公開スタート
• Deno対応ESモジュール対応、IMIコンポーネントツールx4とDenoバッジ