https://github.com/technote-space/zipcode2address-jp

https://github.com/technote-space/zipcode2address-jp

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/technote-space/zipcode2address-jp
• Owner: technote-space
• License: mit
• Created: 2021-03-04T06:27:07.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-12-24T11:00:49.000Z (almost 2 years ago)
• Last Synced: 2025-03-26T23:39:02.686Z (9 months ago)
• Language: TypeScript
• Size: 1.96 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Zipcode to address

[![npm version](https://badge.fury.io/js/%40technote-space%2Fzipcode2address-jp.svg)](https://badge.fury.io/js/%40technote-space%2Fzipcode2address-jp)

[![CI Status](https://github.com/technote-space/zipcode2address-jp/workflows/CI/badge.svg)](https://github.com/technote-space/zipcode2address-jp/actions)

[![codecov](https://codecov.io/gh/technote-space/zipcode2address-jp/branch/master/graph/badge.svg)](https://codecov.io/gh/technote-space/zipcode2address-jp)

[![CodeFactor](https://www.codefactor.io/repository/github/technote-space/zipcode2address-jp/badge)](https://www.codefactor.io/repository/github/technote-space/zipcode2address-jp)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/technote-space/zipcode2address-jp/blob/master/LICENSE)

This library provides method to get japanese address from zipcode.

## Table of Contents

Details

- [Usage](#usage)

  - [Install](#install)

  - [Use](#use)

- [Author](#author)

## Usage

### Install

`yarn add @technote-space/zipcode2address-jp`

or

`npm i @technote-space/zipcode2address-jp`

### Use

e.g.

```ts

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)](https://github.com/technote-space)  

[Blog](https://technote.space)