zipcode-ja

zipcode-ja
---

日本郵便 令和元年6月28日更新 郵便番号データ NodeJS / ブラウザ用 JavaScript

インストール
---

NodeJS
``bash
npm install zipcode-ja --save
`

`js
import zipcodeJa from 'zipcode-ja';
console.log(zipcodeJa.version, zipcodeJa.lastModified); // '0.0.0', '2016-05-31'
`

ブラウザ（Download Latest）
`html


`

デモページ

使用方法
---

zipcodeJaは、一つの巨大なオブジェクトです。実在する郵便番号をキーとして与えると、対応する住所を返します。

`js
console.log(zipcodeJa['1000002']);
// {
// zipcode: '1000002',
// zipcodeOld: '100',
// jisX0402: '13101',
// address: [
// '東京都',
// '千代田区',
// '皇居外苑'
// ],
// ruby: [
// 'とうきょうと',
// 'ちよだく',
// 'こうきょがいえん'
// ],
// status: [
// 0,
// 0,
// 0,
// 0,
// 0,
// 0
// ]
// }
`

それぞれのプロパティは、元データである郵便番号データの説明に対応しています。

* zipcode … 郵便番号（7桁）
* zipcodeOld … （旧）郵便番号（5桁）
* jisX0402 … 全国地方公共団体コード（JIS X0401、X0402）
* address … 都道府県名／漢字, 市区町村名／漢字, 町域名／漢字
* ruby … 都道府県名／半角カタカナ, 市区町村名／半角カタカナ, 町域名／半角カタカナ
* status
0. 一町域が二以上の郵便番号で表される場合の表示
1. 小字毎に番地が起番されている町域の表示
2. 丁目を有する町域の場合の表示
3. 一つの郵便番号で二以上の町域を表す場合の表示
4. 更新の表示
5. 変更理由

注意事項として
* addressの町域名が「以下に掲載がない場合」を「」に置換
* rubyは半角カタカナではなく、全角ひらがなに置換

これは、他のスクリプトから利用する際の手順を省略するための調整です。

他のライブラリとの差異
---
* AjaxZip3/yubinbango と違い、DOM依存を行いません。
* japan-postal-code と違い、コールバック関数を使いません。

開発環境
---
下記がグローバルインストールされていることが前提です。
* NodeJS v6.2.1
* Npm v3.9.3 (or pnpm)

`bash
git clone https://github.com/59naga/zipcode-ja
cd zipcode-ja
npm install

npm test
``

License
---
MIT