Node-Geohash 技术文档

1. 安装指南

安装方式

Node-Geohash 是一个用于 Node.js 的 Geohash 库。你可以通过 npm 来安装这个库。

npm install ngeohash

2. 项目使用说明

基本用法

安装完成后，你可以在你的 Node.js 项目中引入 ngeohash 模块，并使用其提供的功能。

var geohash = require('ngeohash');

// 编码经纬度为 Geohash 字符串
console.log(geohash.encode(37.8324, 112.5584));
// 输出: ww8p1r4t8

// 解码 Geohash 字符串为经纬度
var latlon = geohash.decode('ww8p1r4t8');
console.log(latlon.latitude);  // 输出: 37.8324
console.log(latlon.longitude); // 输出: 112.5584

基本方法

geohash.encode(latitude, longitude, precision=9)

将一对经纬度值编码为 Geohash 字符串。第三个参数是可选的，用于指定 Geohash 字符串的长度，从而影响其精度。

geohash.decode(hashstring)

将 Geohash 字符串解码为经纬度值。返回一个包含 latitude 和 longitude 键的 JavaScript 对象。

geohash.decode_bbox(hashstring)

将 Geohash 字符串解码为匹配的边界框。返回一个四元素数组：[minlat, minlon, maxlat, maxlon]。

geohash.bboxes(minlat, minlon, maxlat, maxlon, precision=9)

获取 [minlat, minlon] 和 [maxlat, maxlon] 之间的所有 Geohash 字符串。这些字符串可以用于在缓存中查找 POI。

geohash.neighbor(hashstring, direction)

在指定方向上查找 Geohash 字符串的邻居。方向是一个二维数组，例如 [1,0] 表示北，[-1,-1] 表示西南。

geohash.neighbors(hashstring)

查找 Geohash 字符串的所有 8 个邻居 [n, ne, e, se, s, sw, w, nw]。

整数方法

geohash.encode_int(latitude, longitude, bitDepth=52)

将一对经纬度值编码为 Geohash 整数。第三个参数是可选的，用于指定整数的 bitDepth，从而影响其精度。

geohash.decode_int(hashinteger, bitDepth=52)

将 Geohash 整数解码为经纬度值。返回一个包含 latitude 和 longitude 键的 JavaScript 对象。

geohash.decode_bbox_int(hashinteger, bitDepth=52)

将 Geohash 整数解码为匹配的边界框。返回一个四元素数组：[minlat, minlon, maxlat, maxlon]。

geohash.bboxes_int(minlat, minlon, maxlat, maxlon, bitDepth=52)

获取 [minlat, minlon] 和 [maxlat, maxlon] 之间的所有 Geohash 整数。

geohash.neighbor_int(hashinteger, direction, bitDepth=52)

在指定方向上查找 Geohash 整数的邻居。

geohash.neighbors_int(hashinteger, bitDepth=52)

查找 Geohash 整数的所有 8 个邻居 [n, ne, e, se, s, sw, w, nw]。

3. 项目 API 使用文档

编码与解码

• geohash.encode(latitude, longitude, precision=9)：将经纬度编码为 Geohash 字符串。
• geohash.decode(hashstring)：将 Geohash 字符串解码为经纬度。

边界框

• geohash.decode_bbox(hashstring)：解码 Geohash 字符串为边界框。
• geohash.bboxes(minlat, minlon, maxlat, maxlon, precision=9)：获取指定范围内的所有 Geohash 字符串。

邻居

• geohash.neighbor(hashstring, direction)：查找指定方向的邻居。
• geohash.neighbors(hashstring)：查找所有 8 个邻居。

整数编码与解码

• geohash.encode_int(latitude, longitude, bitDepth=52)：将经纬度编码为 Geohash 整数。
• geohash.decode_int(hashinteger, bitDepth=52)：将 Geohash 整数解码为经纬度。

整数边界框

• geohash.decode_bbox_int(hashinteger, bitDepth=52)：解码 Geohash 整数为边界框。
• geohash.bboxes_int(minlat, minlon, maxlat, maxlon, bitDepth=52)：获取指定范围内的所有 Geohash 整数。

整数邻居

• geohash.neighbor_int(hashinteger, direction, bitDepth=52)：查找指定方向的邻居。
• geohash.neighbors_int(hashinteger, bitDepth=52)：查找所有 8 个邻居。

4. 项目安装方式

Node-Geohash 可以通过 npm 进行安装：

npm install ngeohash

安装完成后，你可以在项目中通过 require('ngeohash') 引入并使用该库。