klogic-zip-code v1.1.1

klogic-zip-code

郵便番号、もしくは住所から該当住所を検索するライブラリ。

目次

• デモ
• サポートブラウザ
• インストール
• 使用方法
  • 初期化
  • オプション
  • 郵便番号から検索
    • 完全一致
    • 前方一致
  • 住所から検索
    • 完全一致
    • 前方一致
    • 部分一致

デモ

https://k-logic24.github.io/klogic-zip-code/

サポートブラウザ

IE以外のモダンブラウザで使用可能。

インストール

npm使用

npm install klogic-zip-code

yarn使用

yarn add klogic-zip-code

使用方法

初期化

// commonjs
const { KlogicZipCode } = require('klogic-zip-code')
// ES6
import { KlogicZipCode } from 'klogic-zip-code'

const klogicZipCode = new KlogicZipCode()

オプション

import { KlogicZipCode } from 'klogic-zip-code'

const klogicZipCode = new KlogicZipCode({
  limit: 50,
  is_hyphen: true
})

郵便番号から検索

メソッド使用時、引数に以下のオブジェクトをとります。

完全一致

const klogicZipCode = new KlogicZipCode()

klogicZipCode.searchAddressFromZip({
  zipcode: 'xxx-xxxx',
  is_exact: true
})
  .then(data => {
    // do sccess
  })
  .catch(err => {
    // do failture
  })

前方一致

const klogicZipCode = new KlogicZipCode()

klogicZipCode.searchAddressFromZip({
  zipcode: 'xxx',
})
  .then(data => {
    // do sccess
  })
  .catch(err => {
    // do failture
  })

住所から検索

メソッド使用時、引数に以下のオブジェクトをとります。

完全一致

const klogicZipCode = new KlogicZipCode()

klogicZipCode.searchZipFromAddress({
  address: 'xx県oo市△△町',
  is_exact: true
})
  .then(data => {
    // do sccess
  })
  .catch(err => {
    // do failture
  })

前方一致

const klogicZipCode = new KlogicZipCode()

klogicZipCode.searchZipFromAddress({
  address: 'xx県oo市',
  is_left: true
})
  .then(data => {
    // do sccess
  })
  .catch(err => {
    // do failture
  })

部分一致

const klogicZipCode = new KlogicZipCode()

klogicZipCode.searchZipFromAddress({
  address: 'oo市△△町',
})
  .then(data => {
    // do sccess
  })
  .catch(err => {
    // do failture
  })