GoqZipCode

GoqZipCodeは、郵便番号もしくは住所から該当する住所を検索し、住所データを受け取ることができます。

目次

• サポートブラウザ
• デモページ
• インストール
• API
  • 初期化
  • オプション
  • データ返り値
  • 郵便番号から住所を検索
    • 完全一致
    • 前方一致
  • 住所から郵便番号を検索
    • 完全一致
    • 前方一致
    • 部分一致

サポートブラウザ

InternetExplorerを除く、モダンブラウザで使用可能です。　

デモページ

以下のデモページから使用できるメソッドやオプションの一覧が確認できます。
デモページへ

インストール

npmを使用します。

$ npm install goqzipcode

もしくはyarnを使用します。

$ yarn add goqzipcode

CDNも利用可能です。

<script src="https://cdn.jsdelivr.net/npm/goqzipcode@latest/dist/index.min.js"></script>

API

初期化

インポートしたGoqZipCodeを初期化します。

初期化はSSR（サーバーサイドレンダリング）では動きません。
SSRを使用している場合、クライアントサイドで実行するように記述してください。

// commonjs
const { GoqZipCode } = require('goqzipcode')
// ES6
import { GoqZipCode } from 'goqzipcode'
// initialize
const goqZipCode = new GoqZipCode()

オプション

| 名前 | 型 | 初期値 | 説明 | ----|----|----|---- | limit | number | 50 | 取得する住所の上限 | | is_hyphen | boolean | true | 返り値の郵便番号にハイフン(-)を含むか |

const options = {
  limit: 100,
  is_hyphen: false
};

const goqZipCode = new GoqZipCode(options);

データ返り値

配列の中に該当したデータがオブジェクト形式で返ります。

| 名前 | 型 | 説明 | ----|----|---- | city | string | 市区 | | pref | string | 都道府県 | | town | string | 町村 | | zipcode | string | 郵便番号 |

[
  {
    city: "",
    pref: "",
    town: "",
    zipcode: ""
  }
]

郵便番号から住所を検索

郵便番号から住所を検索するにはsearchAddressFromZipcodeメソッドを使用します。
データを検索するタイミングとして、完全一致・前方一致が可能です。

※ -(ハイフン)があった場合、-は除外してカウントされます。

引数のオブジェクトプロパティは以下を設定します。

| 名前 | 型 | 説明 | 必須 | デフォルト値 ----|----|----|----|---- | zipcode | string | 郵便番号 | true | "" | is_exact | boolean | 完全一致の有無 | | false

完全一致

入力番号が7文字必須です。
入力番号と一致したデータを返します。

goqZipCode.searchAddressFromZipcode({
  zipcode: '1040031',
  is_exact: true
})
  .then(result => {
    // do sccess handling 
  })
  .catch(() => {
    // do failure handling 
  })

前方一致

入力番号が2文字以上必須です。
入力番号から都度データ照合をして、該当したデータを返します。

goqZipCode.searchAddressFromZipcode({
  zipcode: '1040031',
})
  .then(result => {
    // do sccess handling 
  })
  .catch(() => {
    // do failure handling 
  })

住所から郵便番号を検索

住所から郵便番号を検索するにはsearchZipcodeFromAddressメソッドを使用します。
データを検索するタイミングとして、完全一致・前方一致・部分一致が可能です。

※いずれも3文字以上必須になります。

引数のオブジェクトプロパティは以下を設定します。

| 名前 | 型 | 説明 | 必須 | デフォルト値 ----|----|----|----|---- | address | string | 住所 | true | "" | is_exact | boolean | 完全一致の有無 | | false | is_left | boolean | 前方一致の有無 | | false

完全一致

入力された住所と一致したデータを返します。

goqZipCode.searchZipcodeFromAddress({
  address: '東京都中央区京橋',
  is_exact: true
})
  .then(result => {
    // do sccess handling 
  })
  .catch(() => {
    // do failure handling 
  })

前方一致

入力された住所と都度データ照合をして、該当したデータを返します。

goqZipCode.searchZipcodeFromAddress({
  address: '東京都中央区',
  is_left: true
})
  .then(result => {
    // do sccess handling 
  })
  .catch(() => {
    // do failure handling 
  })

部分一致

入力された住所が部分的に該当したデータを返します。

goqZipCode.searchZipcodeFromAddress({
  address: '中央区京橋',
})
  .then(result => {
    // do sccess handling 
  })
  .catch(() => {
    // do failure handling 
  })