日本語のREADMEはこちらです: README.ja.md
This is an ES module that converts Japanese zip codes to addresses, including local government codes and town names.
Convert zip codes to addresses
- Converts Japanese zip codes to local government codes and town names
- Automatically updates daily using GitHub Actions
- Provides API for web and Deno usage
Install locally:
$ github clone https://github.com/code4fukui/PostalCode.git
Usage example:
import { PostalCode } from "https://code4fukui.github.io/PostalCode/PostalCode.js";
console.log(await PostalCode.decode(9160042));Output:
[{ zipcode: "9160042", lgcode: "18207", town: "新横江", townyomi: "シンヨコエ" }]
Uses the KEN_ALL.ZIP data from Japan Post.
MIT License — see LICENSE.