Skip to content

technote-space/zipcode2address-jp

Repository files navigation

Zipcode to address

npm version CI Status codecov CodeFactor License: MIT

This library provides method to get japanese address from zipcode.

Table of Contents

Details

Usage

Install

yarn add @technote-space/zipcode2address-jp

or

npm i @technote-space/zipcode2address-jp

Use

e.g.

import {getAddress} from '@technote-space/zipcode2address-jp';

(async() => {
  console.log(await getAddress('1000001'));
  console.log(await getAddress('100-0001'));
  /*
  {
    zipCode: '1000001',
    prefectureJisCode: '13',
    prefectureName: '東京都',
    prefectureNameKana: 'トウキョウト',
    cityJisCode: '13101',
    cityName: '千代田区',
    cityNameKana: 'チヨダク',
    townName: '千代田',
    townNameKana: 'チヨダ'
  }
  */
})();

Author

GitHub (Technote)
Blog