@geoapify/un-locode

中文文档
1.0.3发布于 2025/11/14MITTypeScriptESM + CJS近 30 天下载 1.3万

用于查询联合国地点代码(UN/LOCODE)数据的节点js图书馆

中文使用文档
文档目录16 节
  1. 安装
  2. 使用量
  3. 参数
  4. 回应
  5. 函数代码
  6. 状态代码
  7. 缓冲行为
  8. 数据源更新( U)
  9. 所需资源
  10. 发展 工作流量
  11. 正在测试
  12. 建设图书馆
  13. 重生 JSON 数据
  14. 运行演示
  15. 处理错误
  16. 捐款

@ geoapify/ un- locode( 代码)

用于查询联合国地点代码的轻量级节点Js助手(联合国/利比里亚当地数据。 按国家查找单一位置并设置代码,并(如有)恢复元数据、功能指定和坐标的正常状态.

安装

npm install @geoapify/un-locode

使用量

query 是同步的,返回任意一个 UnlocodeItem 对象或 null国家和位置代码必须分别是ISO 3166-1 alpha-2和UN/LOCODE值的大写.

常见JS :

const { query } = require('@geoapify/un-locode');

const aberdeen = query('US', 'APG');
console.log(aberdeen?.locationName); // "Aberdeen"

无害环境管理/类型脚本:

import { query } from '@geoapify/un-locode';
import type { UnlocodeItem } from '@geoapify/un-locode';

const aberdeen: UnlocodeItem | null = query('US', 'APG');

参数

  • countryCode (单位:千美元)string: ISO 3166-1 α-2代码 (:US, (中文(简体) ), DE, (中文(简体) ), SG(中文(简体) ).
  • locationCode (单位:千美元)string: 联合国/LOCODE 定位代码(3个字符)APG, (中文(简体) ), HAM(中文(简体) ).

回应

示例返回值:

{
  "country": "US",
  "location": "APG",
  "locationName": "Aberdeen",
  "subdivision": "MD",
  "status": "AI",
  "functionCodes": ["3", "4"],
  "coordinates": {
    "lat": 39.5120347,
    "lon": -76.1643289
  }
}
  • country: ISO国家代码.
  • location: 联合国/LOCODE位置代码.
  • locationName:名称不带二甲酸.
  • subdivision:可选状态/省值.
  • status: 双字母UN/LOCODE状态代码.
  • functionCodes: 函数命名阵列(见下文).
  • coordinates:可选 WGS84 纬度/经度对.

说明:原始UN/LOCODE垃圾堆中的一些行缺乏坐标. 我们用那两行来丰富 地理编码 API 生成捆绑数据集时.

函数代码

  • 1个 = 港口(任何水上运输)
  • 2个 = 铁路终点站
  • 3个 = 公路终点站
  • 页:1 = 机场
  • 页:1 =邮政交换所
  • 6个 = 内陆清除站/陆港
  • 第7条 = 固定运输功能(管道、电线、绳道等)
  • 页:1 = 过境
  • 0 个 = 函数未知/ 未指定

状态代码

  • AA 对: 经主管国家政府机构核准
  • 空调: 海关当局核准
  • 亚足联: 经国家促进机构核准
  • 大赦国际由国际组织(如空运协会或拉加经委会)通过
  • 上午联合国/LOCODE维护机构核准
  • 问题: 已核准条目,未核实功能
  • AS: 经国家标准化机构核准
  • 转写:经地名录或其他参考资料确认的公认位置
  • 核: 国家可靠来源就其国内地点提出的请求
  • RQ 问题: 审议中的请求
  • 欧元: 应用户请求列入条目; 未正式核准
  • 资源: 请求被驳回
  • QQ 时间轴:: 原条目自注明日期起未经核实
  • 二十: 下期《联合国/LOCODE》中要删除的条目

缓冲行为

图书馆懒散地在每个国家装入CSV文件,并将它们保存在内存中长达24小时. 长跑进程从重复查询中受益,而缓存则会自动去除 stale 条目. 如果您需要更严格的控制(例如,在批处理后释放内存),则重新启动进程或只加载您需要的国家.

数据源更新( U)

  • 存放处目前与欧洲经委会一道进行航行 2024-2 (英语) 联合国/LOCODE发布(2025年1月发布) data-source/2024-2 UNLOCODE CodeList.csv。 。 。 .
  • Geoapify 的地理编码 API 用于补充官方垃圾堆中缺少纬度/经度的行的坐标.
  • 为更新数据集重新生成JSON/CSV资产:
    1. 将新的 CSV/ XLS 文件放入其中 data-source/。 。 。 .
    2. 添加您的内容 API_KEY 改为 src/utility/utility.ts (在地理编码时使用).
    3. 运行 npm run generate-files (见 BUILD.md 详细情况请查阅.

所需资源

  • 节点.js 18.0.0 (单位:千美元) 或更新(生成器脚本依赖现代的ECMAScript特性).
  • npm(带节点来)用于运行所提供的脚本.

一次通过 npm install,然后根据需要使用下面的命令.

发展 工作流量

正在测试

npm test

建设图书馆

npm run build-all

这样可以编译TypeScript源并捆绑被打包的JSON资产.

重生 JSON 数据

  1. 将最近的 CSV/ XLS 导出到根中 data-source/ 文件夹.

  2. 添加您的 Geoapify API 密钥到 src/utility/utility.ts。 。 。 .

  3. 运行 :

    npm run generate-files
    

运行演示

  1. 构建项目( E)npm run build-all) (中文(简体) ).

  2. 启动演示应用 :

    npm run start:demo
    

处理错误

query 返回时 null 国家/地点组合不存在。 在你的申请中一定要小心.

捐款

欢迎捐款! 请将仓库叉出, 更改, 并提交拉动请求 。 见 BUILD.md 用于完整的数据生成指令.

版本与发布记录

@geoapify/un-locode 共发布 4 个版本,首次发布于 2024/10/28;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.3latest2025/11/141 年前
1.0.22024/10/302 年前
1.0.12024/10/302 年前
1.0.02024/10/282 年前

关于 @geoapify/un-locode 的常见问题

@geoapify/un-locode 是什么?

用于查询联合国地点代码(UN/LOCODE)数据的节点js图书馆

如何安装 @geoapify/un-locode?

在项目目录运行 npm install @geoapify/un-locode,或使用 pnpm add / yarn add / bun add。

@geoapify/un-locode 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@geoapify/un-locode 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@geoapify/un-locode 可以商用吗?

@geoapify/un-locode 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@geoapify/un-locode 的下载量有多少?

根据 npm 官方下载统计,@geoapify/un-locode 在 2026/10/16 – 2026/11/14 这 30 天内被下载 13,134 次,日均约 438 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@geoapify/un-locode 还在维护吗?

最新版本 1.0.3 发布于 2025/11/14(1 年前);至今共发布 4 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/10/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。