twzipcode-data

開發用中華郵政郵遞區號 / Variety format of Taiwan zipcode for developers.

Usage no npm install needed!

<script type="module">
  import twzipcodeData from 'https://cdn.skypack.dev/twzipcode-data';
</script>

README

TwZipcode

開發用中華郵政郵遞區號 / Taiwan zipcodes for developers.

  1. 將中華郵政的 「臺灣地區郵遞區號前3碼一覽表 103/12(Excel版)」 轉成js，方便開發時可直接引用。
  2. 英文譯名來自於地名資訊服務網的 「臺灣地區鄉鎮市區級以上行政區域名稱中英對照表.pdf」 。

Travis Coverage Status npm npm npm dependencies devDependency GitHub stars

Install

Bower

bower install twzipcode-data

npm

npm install twzipcode-data --save-dev

用法 Usage

import twzipcode from 'twzipcode-data'

// 英文
let data_en = twzipcode('en')

// 預設中文
let data = twzipcode()

// 或是傳入Accept-Language
let data_guess = twzipcode('zh-TW,zh;q=0.8,en-US;q=0.5,en;q=0.3')

// 所有縣市
let counties = data.counties

// 所有郵遞區號
let zipcodes = data.zipcodes

資料結構 / Data Structure

縣市 / County Object

參數 說明
id 中文名稱
name 縣市名稱

郵遞區號 / Zipcode Object

參數 說明
id 3碼郵遞區號
county 縣、市或直轄市中文名稱
city 鄉鎮市區中文名稱

Build Setup

# install dependencies
npm install

# run tests
npm run test

# build for production with minification
npm run build

i18n

  1. Create a directory in ./src/{locale}.
  2. In ./src/{locale}, add counties.js and zipcodes.js.
  3. In ./test, add integrity.test.{locale}.js.
  4. In .src/locales.js, append {locale} to export array.

See src/zh-tw.

Directory name should be lowercase(zh-tw), locale name in files should be uppercase for extra information(zh-TW).

vue-twzipcode

中華郵政郵遞區號 Vuejs components：twzipcode-vue