zip-code-jp
郵便番号から、住所を検索できるモジュールです。
郵便番号データのソースは郵便事業株式会社(旧郵政省)提供のデータを使用しています。
postal-code-jpを使用している場合は、代わりにzip-code-jpを使用してください。
インストール方法
下記のコマンドでインストールできます。
npm install zip-code-jp
基本的な使用方法
郵便番号から、住所の情報を返します。
; const resolver = ; resolver;
検索結果のキャッシュ
キャッシュに利用するアダプタを変えることで、独自のキャッシュ処理に切り替えることができます。
デフォルトでは、MemoryCacheAdapterを使用して、メモリにキャッシュします。
;; const memoryAdapter = ;const resolver = memoryAdapter; resolver;
独自アダプタの実装
CacheAdapterをサブクラス化して、独自のアダプタを使用できるようになります。
下記のメソッドを実装する必要があります。
- find(prefix) - 郵便番号の頭3桁を引数に取り、該当する辞書を返します。
- store(prefix, store) - 郵便番号の頭3桁と、辞書を受け取り、キャッシュします。
;; CacheAdapter { super; } /** * Search the dictionary from the cache * * @param * @return Promise<Object> */ { } /** * Cache the dictionary * * @param * @param * @return Promise<void> */ { } const resolver = ; resolver;
辞書ファイルの更新
npm run index
テストの実行
次のコマンドで、テストを実行できます。
npm install
npm test