# @goway\.to/sdk 中文文档

规范地址：https://npmcn.com/package/%40goway.to/sdk/

版本：0\.7\.1
npm 元数据更新时间：2026-10-25T09:06:28.885Z
中文译文更新时间：2026-11-17T05:21:36.722Z
软件包许可：SEE LICENSE IN LICENSE

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40goway.to/sdk
原文对照：https://npmcn.com/package/%40goway.to/sdk/?lang=original
项目主页：https://github.com/OxyHQ/GoWay/tree/main/packages/sdk#readme
源码仓库：https://github.com/OxyHQ/GoWay

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.7 MB，25 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- 首次发布：2026-09-20T10:57:21.553Z
- 最新版本发布：2026-10-25T09:06:28.445Z
- 近 30 天下载量：6125（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

GoWay公共地理API的无头型TypeScript客户端——位置,能力过滤器,搜索,地理编码,路由,打出的错误和为Node,Bun,浏览器和React Introduct提供的犬类链接.

## 安装

```sh
npm install @goway.to/sdk
```

也可以使用：`pnpm add @goway.to/sdk`、`yarn add @goway.to/sdk`、`bun add @goway.to/sdk`

## README

# @goway.to/sdk (英语)

GoWay公共地理学API的TypeScript客户端:GoWay地段和容量过滤,搜索,地理编码,路由,活车,道路规则,以及Cononic GoWay链接和地图风格URL. 每个请求在发送前都会被验证,每个回复都会被解析出对应API自己的合同,每个失败都是打出错误. 它运行于节点18+, Bun, 浏览器和React Industrial, 并且仅依赖于 `zod`。 。 。 .

## 安装

```bash
npm install @goway.to/sdk
```

## 快开始

```ts
import { createGoWayClient, placeDisplayName } from '@goway.to/sdk';

const goway = createGoWayClient({ locale: 'en' });

const nearby = await goway.places.nearby({
  latitude: 41.3874,
  longitude: 2.1686,
  radiusMeters: 1000,
  capabilities: ['payments.faircoin.accepted'],
});

for (const place of nearby.items) {
  console.log(placeDisplayName(place), Math.round(place.distanceMeters), 'm', goway.links.place(place));
}
```

搜索、浏览和路由不需要账户。 Oxy 应用程序使用会话 共享传输, 自动刷新和栅栏账户更改 :

```ts
const linked = oxyServices.createLinkedClient({ baseURL: apiBaseUrl });
const goway = createGoWayClient({ apiBaseUrl, fetch: linked.fetchOptional });
// Dispose the linked client when its owning application context is released.
```

一般情况 `getAccessToken` 选项仍可供外部整合使用 拥有他们象征的生命周期。 拥有的应用程序不会复制会话符号 .

## 入境点

| 导入 | 目录 |
| --- | --- |
| `@goway.to/sdk` | HTTP 客户端 (`createGoWayClient`),打出错误,页码,合同类型和帮助者. |
| `@goway.to/sdk/live` | (原始内容存档于2018-09-29). The GoWay Live Socket. IO协议:事件,房间瓦片,消息解析器. 带上你自己的 `socket.io-client`。 。 。 . |
| `@goway.to/sdk/geo` | Web Mercator),横跨时空的盒子,相距,像素投影. |
| `@goway.to/sdk/road-access` | 谁可能使用一条道路,来自OpenStreetMap访问标记. |
| `@goway.to/sdk/map` | 地图样式名称与文档,样式目录,瓷砖图案,本地化标签. 没有 `zod`。 。 。 . |

## 文档

-   [概览、客户选项和认证](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/README.md)
-   指南: [地点](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/guides/places.md), (中文(简体) ), [搜索](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/guides/search.md), (中文(简体) ), [地理编码](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/guides/geocoding.md), (中文(简体) ), [路线](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/guides/routing.md), (中文(简体) ), [链接](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/guides/links.md), (中文(简体) ), [现场直播](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/guides/live.md), (中文(简体) ), [错误](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/guides/errors.md), (中文(简体) ), [倾斜](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/guides/pagination.md)
-   [实例](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/examples/README.md)
-   API 参考 : [`@goway.to/sdk`](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/api-reference/index.md), (中文(简体) ), [`/live`](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/api-reference/live.md), (中文(简体) ), [`/geo`](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/api-reference/geo.md), (中文(简体) ), [`/road-access`](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/api-reference/road-access.md), (中文(简体) ), [`/map`](https://github.com/OxyHQ/GoWay/blob/main/docs/developers/sdk/api-reference/map.md)

## 许可证

`SEE LICENSE IN LICENSE`: 术语在 [自由主义](https://github.com/OxyHQ/GoWay/blob/main/packages/sdk/LICENSE) 使用此软件包运出的文件.

## 常见问题

### @goway\.to/sdk 是什么？

GoWay公共地理API的无头型TypeScript客户端——位置,能力过滤器,搜索,地理编码,路由,打出的错误和为Node,Bun,浏览器和React Introduct提供的犬类链接\.

### 如何安装 @goway\.to/sdk？

在项目目录运行 npm install @goway\.to/sdk，或使用 pnpm add / yarn add / bun add。

### @goway\.to/sdk 支持 TypeScript 吗？

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

### @goway\.to/sdk 支持 ESM 还是 CommonJS？

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

### @goway\.to/sdk 需要什么版本的 Node\.js？

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

### @goway\.to/sdk 可以商用吗？

@goway\.to/sdk 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @goway\.to/sdk 的下载量有多少？

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

### @goway\.to/sdk 还在维护吗？

最新版本 0\.7\.1 发布于 2026/10/25（22 天前）；至今共发布 7 个版本，其中过去 12 个月发布了 7 个；首次发布于 2026/09/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

