介绍
geonames-reader 是一个用于解析 Geonames 数据库文件的 npm 包。Geonames 是一个涵盖全球地名的数据库，包含约 25 万个地名，以及它们的位置、类别等信息。geonames-reader 提供了一些接口，让你可以方便地读取 geonames 数据库文件，以便用于你的前端项目中。
安装
在开始使用 geonames-reader 前，你需要先在你的项目中安装它。你可以使用 npm 进行安装。
npm install geonames-reader
使用
geonames-reader 提供了两个方法来读取 Geonames 数据库文件：
read(filepath: string): Promise<GeonamesData[]>
该方法用于读取 Geonames 文件，并返回一个 Promise，Promise 的值是一个 GeonamesData 类型的数组。每个 GeonamesData 对象代表一个地名信息。地名信息包含以下字段：
-- -------------------- ---- ------- ---- ------------ - - ------ ------- -- -------- -- ----- ------- -- -- ---------- ------- -- ------------- ----- - --------------- --------- ----- --------- ------- -- -- ---------- ------- -- -- ------------- ------- -- ----- ------------ ------- -- -------- ------------ ------- -- --------- ------------ ------- -- --------- ------------ ------- -- ------- -
示例代码：
const { read } = require('geonames-reader');
(async () => {
const filepath = '/path/to/geonames/file';
const res = await read(filepath);
console.log(res);
})();createReadStream(filepath: string): GeonamesReadable
该方法用于为指定地名数据库文件创建一个可读流（Readable）。返回值是 GeonamesReadable 类型的实例，你可以将其传递给你想要的 Node.js API 来处理流。GeonamesReadable 类型的实例提供了以下方法：
GeonamesReadable.on('data', callback: (data: GeonamesData) => void)
数据事件。当有新的地名数据读取时，该事件将被触发，并返回一个 GeonamesData 类型的对象。
GeonamesReadable.on('end', callback: () => void)
当所有的数据都读取完毕，该事件将被触发。
示例代码：
-- -------------------- ---- ------- ----- - ---------------- - - --------------------------- ----- -- - -------------- ----- -------- - ------------------------- ----- -------- - --------------------------- ------------------- ---- -- - ------------------ --- ------------------ -- -- - -------------------- ---
总结
geonames-reader 提供了方便的接口来读取 Geonames 数据库文件。无论是使用 read 方法，还是 createReadStream 方法，你都可以轻松地将地名数据读取到你的项目中。如果你的项目需要与 Geonames 数据库打交道，那么 geonames-reader 绝对值得一试。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/geonames-reader