@goway.to/sdk (英语)
GoWay公共地理学API的TypeScript客户端:GoWay地段和容量过滤,搜索,地理编码,路由,活车,道路规则,以及Cononic GoWay链接和地图风格URL. 每个请求在发送前都会被验证,每个回复都会被解析出对应API自己的合同,每个失败都是打出错误. 它运行于节点18+, Bun, 浏览器和React Industrial, 并且仅依赖于 zod。 。 。 .
安装
npm install @goway.to/sdk
快开始
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 应用程序使用会话 共享传输, 自动刷新和栅栏账户更改 :
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。 。 。 . |
文档
- 概览、客户选项和认证
- 指南: 地点, (中文(简体) ), 搜索, (中文(简体) ), 地理编码, (中文(简体) ), 路线, (中文(简体) ), 链接, (中文(简体) ), 现场直播, (中文(简体) ), 错误, (中文(简体) ), 倾斜
- 实例
- API 参考 :
@goway.to/sdk, (中文(简体) ),/live, (中文(简体) ),/geo, (中文(简体) ),/road-access, (中文(简体) ),/map
许可证
SEE LICENSE IN LICENSE: 术语在 自由主义 使用此软件包运出的文件.