# @bilte-co/socky-js 中文文档

规范地址：https://npmcn.com/package/%40bilte-co/socky-js/

版本：0\.6\.3
npm 元数据更新时间：2026-06-02T22:01:48.815Z
中文译文更新时间：2026-11-08T02:39:54.878Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40bilte-co/socky-js
原文对照：https://npmcn.com/package/%40bilte-co/socky-js/?lang=original
项目主页：https://github.com/bilte-co/socky-js#readme
源码仓库：https://github.com/bilte-co/socky-js

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

- 包体积（解压后）：111 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2025-10-27T23:54:49.896Z
- 最新版本发布：2026-06-02T22:01:48.527Z
- 近 30 天下载量：3869（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 3 个）

## 中文简介

用于 Socky Flights API 的 JavaScript SDK

## 安装

```sh
npm install @bilte-co/socky-js
```

也可以使用：`pnpm add @bilte-co/socky-js`、`yarn add @bilte-co/socky-js`、`bun add @bilte-co/socky-js`

## README

# 好恶心

JavaScript SDK用于索克航班API的公共路线.

## 安装

```sh
aube add @bilte-co/socky-js
# or: npm i @bilte-co/socky-js
```

## 快速启动( ESM)

```js
import { Socky } from 'socky';

// Do not expose your API key to the client.
const client = new Socky({ apiKey: process.env.SOCKY_API_KEY });

// Get flight data
const flight = await client.flights.get('01JCTA5XQZF8B3G5N2W9K7M4VP');

// Get aircraft information
const aircraft = await client.aircraft.get('N12345');

// List stations with pagination
const stations = await client.stations.list();
console.log(stations.items);
console.log(stations.hasMore);
```

## 快速启动( CJS)

```js
const { Socky } = require('socky');

// Do not expose your API key to the client.
const client = new Socky({ apiKey: process.env.SOCKY_API_KEY });

// Use the client as shown above
```

## 配置

SDK接受以下配置选项:

```js
const client = new Socky({
  apiKey: 'your-api-key',        // Required
  baseUrl: 'https://api.custom.com/',  // Optional, defaults to 'https://api.socky.flights/'
  version: 'v1',                  // Optional, defaults to 'v1'
  timeoutMs: 30000,               // Optional, request timeout in ms (default: 30000)
  retries: 2,                     // Optional, number of retries on failure (default: 2)
  retryBackoffMs: 250,            // Optional, initial retry backoff in ms (default: 250)
  userAgent: 'my-app/1.0',       // Optional, custom user agent string
});
```

## 处理错误

SDK 投出键 `ApiError` 有详细信息的实例 :

```js
import { Socky, ApiError } from 'socky';

try {
  const flight = await client.flights.get('invalid-id');
} catch (error) {
  if (error instanceof ApiError) {
    console.log(error.status);      // HTTP status code
    console.log(error.message);     // Error message
    console.log(error.code);        // Optional error code from API
    console.log(error.requestId);   // Optional request ID for debugging
    console.log(error.retryAfterMs); // Optional retry-after hint
    console.log(error.body);        // Raw error response body
  }
}
```

## 倾斜

平分终点返回 a `Page<T>` 用于重排的帮助对象 :

```js
// Manual pagination
let page = await client.stations.list();
console.log(page.items);

if (page.hasMore && page.nextCursor) {
  const nextPage = await client.stations.list(page.nextCursor);
}

// Automatic page iteration
for await (const page of client.stations.paginatePages(20, 10)) {
  console.log(`Page with ${page.items.length} stations`);
}

// Automatic item iteration
for await (const station of client.stations.paginateItems(20, 10)) {
  console.log(station.code);
}
```

## 复读和超时

SDK 自动重试请求短暂错误失败 :

-   检讨:429起(限速)、503起、504起和5xx出错
-   尊重 `Retry-After` 页眉
-   使用以指数为单位的反转
-   网络错误也被重审
-   默认情况下只重审 GET 请求

## API 密码

SDK提供下列Socky Flights API端点的出入口:

### 飞机

-   `aircraft.get(registration)` - 通过登记获得飞机
-   `aircraft.list(cursor?, limit?)` - 列入清单的飞机(贴上标签)
-   `aircraft.position(registration)` - 获取最后已知位置
-   `aircraft.flights(registration, cursor?, limit?)` - 获得飞机飞行(油漆)

### 飞行

-   `flights.get(ulid)` - 通过身份证明飞行
-   `flights.track(ulid)` - 获取飞行轨道数据

### 地点

-   `locations.get(lat, lng)` - 获取位置信息

### 职位

-   `positions.latest(tails)` - 获取飞机的最新位置(接受字符串或阵列)

### 路线

-   `routes.get(from, to)` - 获取两个车站之间的路线信息

### 车站

-   `stations.get(code)` - 按密码报到
-   `stations.list(cursor?, limit?)` - 列出所有站点(贴上)
-   `stations.search(query)` - 搜索站的名称或代码
-   `stations.proximity({ latitude, longitude, distance?, unit? })` - 寻找坐标附近的站点
-   `stations.near(code, { distance?, unit? })` - 在另一站附近寻找站台
-   `stations.paginatePages(limit?, pageLimit?)` - 逐行逐行
-   `stations.paginateItems(limit?, pageLimit?)` - 个别物品的提法

## 节点支持

节点 18.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @bilte-co/socky-js 是什么？

用于 Socky Flights API 的 JavaScript SDK

### 如何安装 @bilte-co/socky-js？

在项目目录运行 npm install @bilte-co/socky-js，或使用 pnpm add / yarn add / bun add。

### @bilte-co/socky-js 支持 TypeScript 吗？

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

### @bilte-co/socky-js 支持 ESM 还是 CommonJS？

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

### @bilte-co/socky-js 需要什么版本的 Node\.js？

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

### @bilte-co/socky-js 可以商用吗？

@bilte-co/socky-js 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bilte-co/socky-js 的下载量有多少？

根据 npm 官方下载统计，@bilte-co/socky-js 在 2026/10/08 – 2026/11/06 这 30 天内被下载 3,869 次，日均约 129 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bilte-co/socky-js 还在维护吗？

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