# @cigale/beamup 中文文档

规范地址：https://npmcn.com/package/%40cigale/beamup/

版本：0\.6\.5
npm 元数据更新时间：2025-09-24T10:37:15.232Z
中文译文更新时间：2026-11-09T16:04:41.291Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cigale/beamup
原文对照：https://npmcn.com/package/%40cigale/beamup/?lang=original
项目主页：https://github.com/cigaleapp/beamup
源码仓库：https://github.com/cigaleapp/beamup

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

- 包体积（解压后）：30.6 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：typescript ^5\.9\.2
- 首次发布：2025-09-20T16:34:26.013Z
- 最新版本发布：2025-09-24T10:37:14.768Z
- 近 30 天下载量：7331（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

向 CIGALE BeamUp 服务器发送更正的打印客户端

## 安装

```sh
npm install @cigale/beamup
```

也可以使用：`pnpm add @cigale/beamup`、`yarn add @cigale/beamup`、`bun add @cigale/beamup`

## README

# 光束

向 CIGALE BeamUp 服务器发送更正 .

## 客户端库

### 使用量

```ts
import { sendCorrections } from "@cigale/beamup";

await sendCorrections({
    origin: "https://beamup.example.com",
    corrections: [ ... ]
})
```

## 服务器

### 使用量

使用 Docker 图像 :

```sh
docker run -p 8000:3000 -e PROD=true -v ./db/:/app/db/:rw ghcr.io/cigaleapp/beamup:latest
```

-   `-p`:在主机上收听:8000
-   `-e`: 设置为生产模式
-   `-v`:挂载主机的./db目录到容器的./app/db(确保您可以写入 dih)

### 发展

要安装依赖性 :

```bash
bun install
```

要运行 :

```bash
bun run src/index.ts
```

制定:

```bash
bun run --watch src/index.ts
```

此工程是使用 `bun init` 在包子v1.2.21. [阿宝](https://bun.com/) 是一个快速的全能JavaScript运行时间.

## 常见问题

### @cigale/beamup 是什么？

向 CIGALE BeamUp 服务器发送更正的打印客户端

### 如何安装 @cigale/beamup？

在项目目录运行 npm install @cigale/beamup，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^5\.9\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cigale/beamup 支持 TypeScript 吗？

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

### @cigale/beamup 支持 ESM 还是 CommonJS？

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

### @cigale/beamup 可以商用吗？

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

### @cigale/beamup 的下载量有多少？

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

### @cigale/beamup 还在维护吗？

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