はじめに

全国地方公共団体コードヘルパは、日本の全国地方公共団体コードを JavaScript から扱うための npm パッケージです。

パッケージは 2 種類に分かれています。

  • @b4moss/jp-local-gov-id: アプリケーション(API)
  • @b4moss/jp-local-gov-id-data: 地方自治体データ(index.json + .bin.br + 検索索引)

旧来の JSON 一括データ配布ではありません。Brotli 圧縮バイナリを分割配信し、全国検索はハイブリッド n-gram 索引で候補を絞ります。

詳しくは 使い方 を参照してください。

次のステップ

  1. インストール — パッケージを入れる
  2. 使い方 — クライアントを初期化して呼び出す
  3. API — 公開メソッドの詳細
  4. Playground — ブラウザ上で試す

サンプルコードの置き場は サンプル を参照してください。