@geolens/sdk

中文文档
1.31.0发布于 2026/11/10Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 2926

为GeoLens API自动生成的TypeScript SDK. 与 Bearer + API- key 认证帮助器一起键入客户端.

中文使用文档
文档目录4 节
  1. 安装
  2. 快速启动
  3. 错误
  4. 重定向

@geolens/ sdk (TypeScript) (英语)

自动生成类型SDK 地球轨道 API (英语).

Apache -2.0 许可。 土著 fetch 客户端+打出的请求/响应接口+ Bearer-token + API- key 认证帮助器. 需要节点18+(或任何运行时间) fetch) (中文(简体) ).

见 页面存档备份,存于互联网档案馆. docs.getgeolens.com 用于安装、再生和版本夹政策.

安装

npm install @geolens/sdk

一揽子措施仅是无害环境管理(import没有 require) (中文(简体) ).

快速启动

import { createGeolensClient } from '@geolens/sdk';

const sdk = createGeolensClient({
  // The deployed API is served under /api, so include that suffix in baseUrl.
  baseUrl: 'https://geolens.example.com/api',
  bearerToken: '...',
});
// See docs.getgeolens.com for endpoint usage examples.

错误

生成呼叫返回 { data, error, response } 别扔出HTTP 错误状态 . error 是解析 application/problem+json 机构 (单位:千美元)type, (中文(简体) ), title, (中文(简体) ), status, (中文(简体) ), detail:

import { createGeolensClient, getSingleDatasetDatasetsDatasetIdGet } from '@geolens/sdk';

const sdk = createGeolensClient({ baseUrl: 'https://geolens.example.com/api', apiKey: '...' });
const { data, error, response } = await getSingleDatasetDatasetsDatasetIdGet({
  client: sdk.client,
  path: { dataset_id: '00000000-0000-0000-0000-000000000000' },
});
if (error) {
  console.error(response.status, error.detail);
}

与 throwOnError: true 调用抛出解析出的错误正文, 普通对象 而不是一个 Error 举个例子.

createGeolensClient() 返回该呼叫的客户端范围( e)sdk.client) (中文(简体) ). 把它明确传递给每一个生成的终点呼叫—— { client: sdk.client } ——当您在同一过程中构建多个客户端(例如,一个) 每个请求在服务器中,所以并行调用者不能干预每个请求 其他费用。 选择 client 从生成的呼叫返回到共享 最新的全进程默认值 createGeolensClient() 调用 配置; 单客户端脚本的默认可以, 但是是 最后呼叫者胜过同时期客户.

重定向

当重定向离开 GeoLens 来源时, 当 COG 下载时发生 从对象存储服务, SDK 不发送证书或客户端头 在这里。 仅 Range 编辑 If-* 附带条件的标头也随之而来.

在节点,SDK跟随GET 和头方向自己。 一个跳出 GeoLens 来源于全球 fetch,不是客户的 fetch 选项 (一个带有 undici 的代理集) setGlobalDispatcher 页:1.

在浏览器中,如果重定向的目标无法读取,则请求会携带 Authorization 或者说 X-API-Key 失败 RedirectError,以及任何其他 请求会再次发送,没有 cookie, 以便浏览器遵循 。 要下载 a COG there, mint a 下载符号(POST /auth/download-token/{dataset_id}(中文(简体) ) 获取 /datasets/{dataset_id}/download/cog?token=... 没有证书.

这适用于默认 redirect: 'follow'设置 redirect: 'manual' 或者说 'error',每个呼叫或客户,你得到什么 fetch 给予: 重新定向未跟踪返回, 或 a TypeError。 。 。 .

版本与发布记录

@geolens/sdk 共发布 61 个版本,首次发布于 2026/05/03;过去 12 个月发布了 61 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.31.0latest2026/11/106 天前
1.30.12026/11/097 天前
1.30.02026/11/088 天前
1.29.22026/11/0214 天前
1.29.12026/10/3115 天前
1.29.02026/10/3115 天前

关于 @geolens/sdk 的常见问题

@geolens/sdk 是什么?

为GeoLens API自动生成的TypeScript SDK. 与 Bearer + API- key 认证帮助器一起键入客户端.

如何安装 @geolens/sdk?

在项目目录运行 npm install @geolens/sdk,或使用 pnpm add / yarn add / bun add。

@geolens/sdk 支持 TypeScript 吗?

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

@geolens/sdk 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@geolens/sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@geolens/sdk 可以商用吗?

@geolens/sdk 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@geolens/sdk 的下载量有多少?

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

@geolens/sdk 还在维护吗?

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