reversegeojp-client
v0.1.1
Published
Minimal TypeScript/JavaScript client for the ReverseGeoJP API (Japan reverse geocoding & geocoding).
Maintainers
Readme
reversegeojp-client
ReverseGeoJP の公式軽量クライアントライブラリです。日本国内の緯度経度⇔住所(町丁目)変換APIを、TypeScript/JavaScriptから型付きで呼び出せます。
- 依存パッケージなし(ランタイムは標準の
fetch/URLのみ) - Node.js 18+、ブラウザ、Cloudflare Workers、Deno、Bunで動作
- ESM専用
インストール
npm install reversegeojp-clientAPIキーの取得
reversegeojp.com でアカウント登録すると発行されます。無料枠あり。
使い方
import { ReverseGeoJPClient } from 'reversegeojp-client';
const client = new ReverseGeoJPClient(process.env.REVERSEGEOJP_API_KEY!);
// 緯度経度 → 住所
const address = await client.reverse(35.6595, 139.6987);
console.log(address);
// { prefecture: '東京都', city: '渋谷区', town: '道玄坂二丁目', zipcode: '1500043', zipcode_candidates: [...], distance_m: 12.3 }
// 住所 → 候補(部分一致、最大10件)
const candidates = await client.geocode('渋谷区道玄坂');
console.log(candidates.results);エラーハンドリング
import { ReverseGeoJPClient, ReverseGeoJPError } from 'reversegeojp-client';
try {
await client.reverse(35.6595, 139.6987);
} catch (e) {
if (e instanceof ReverseGeoJPError) {
console.error(e.status, e.code, e.message, e.requestId);
if (e.code === 'rate_limited') {
console.log('retry after', e.retryAfter, 'seconds');
}
}
}API
new ReverseGeoJPClient(apiKey, options?)
options.baseUrl— 既定はhttps://api.reversegeojp.comoptions.fetch— カスタムfetch実装を注入したい場合に指定
client.reverse(lat, lon): Promise<ReverseResult>
client.geocode(address): Promise<GeocodeResult>
詳細な型定義は dist/index.d.ts を参照してください。
ライセンス
MIT
