# @eddyq/wakeboard 中文文档

规范地址：https://npmcn.com/package/%40eddyq/wakeboard/

版本：0\.2\.0
npm 元数据更新时间：2026-11-04T18:33:59.933Z
中文译文更新时间：2026-11-14T15:20:44.166Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：127 kB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- peer 依赖：express \>=4，fastify \>=4，@nestjs/core \>=10，@nestjs/common \>=10，@fastify/static \>=7，@nestjs/platform-express \>=10，@nestjs/platform-fastify \>=10
- 首次发布：2026-05-11T22:35:33.431Z
- 最新版本发布：2026-11-04T18:33:59.605Z
- 近 30 天下载量：2007（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 22 个）

## 中文简介

eddyq-wakeboard – Eddyq 的 Svelte 管理仪表板,可挂载为 NestJS 模块

## 安装

```sh
npm install @eddyq/wakeboard
```

也可以使用：`pnpm add @eddyq/wakeboard`、`yarn add @eddyq/wakeboard`、`bun add @eddyq/wakeboard`

## README

# @ eddyq/ 醒牌

网络仪表板用于 [埃迪克语name](https://github.com/eddyqueue/eddyq). 滴入巢JS 模块 + Svelte SPA — 在您的应用程序下挂载, 并停止写入一次性管理员 结束点.

```
pnpm add @eddyq/wakeboard
```

## 你得到的东西

-   **实时数据** ——按(队列,州)计.
-   **工作检查** ——有过滤器的相接列表:状态,队列,类型,组,标记.
-   **队列管理员** ——暂停 / 恢复 / 设置货币 / 设定超时 .
-   **组管理员** ——暂停 / 恢复 / 设置货币上限 / 设置符号- bucket 利率限制 .
-   **附表管理** — 启用/ 禁用/ 删除 cron + 间隔调度 .
-   **取消待定任务** -一击.
-   **后端选择器** 当Postgres和Redis被连接到一个应用程序时,每个标签都会得到一个 `?provider=` 选择器以覆盖视图.

## 快开始

```ts
import { Module } from "@nestjs/common";
import { EddyqModule } from "@eddyq/nestjs";
import { EddyqWakeboardModule } from "@eddyq/wakeboard";

@Module({
  imports: [
    EddyqModule.forRoot({
      databaseUrl: process.env.DATABASE_URL!,
      // …or `redis: { url, line }`, or both with `queues` + `defaultProvider`.
    }),
    EddyqWakeboardModule.forRoot({
      mountPath: "/wakeboard",
      auth: { password: process.env.WAKEBOARD_PASSWORD! },
    }),
  ],
})
export class AppModule {}
```

点击 `http://localhost:3000/wakeboard`说定了.

## 多后端支持

Wakeboard 自动检测后端形状 `EddyqModule.forRoot` 配置 :

-   **仅限邮资** ^ 一列统计,一组队列/组/排行.
-   **仅重写** 一样的形状,刚从Redis源出.
-   **两者** (单位:千美元)`EddyqApp`\+ 每一个标签上有一个后端选择器+ a `GET /wakeboard/api/providers` 列出已配置后端的结束点 。 用户界面将每个后端的数据范围分配给其提供者.

所有管理行动都接受 `?provider=postgres|redis` 所以右边的后端 处理每个呼叫。 队列 / 组合键不会在后端出血—— a `tenant-acme` redis 上的组是一个不同于同一名称的桶 Postgres, 仪表板显示它们是这样.

## (原始内容存档于2013-10-12) (英语). REST API

UI所做的一切也是干净的REST表面, 把它接入你的 拥有监控或CLI。 所有终点都接受 `?provider=postgres|redis` 内 多后端设置.

| 终点 | 目的 |
| --- | --- |
| `GET /api/providers` | 后端此应用程序被接通 |
| `GET /api/stats` | 按(队列,状态)计数 |
| `GET /api/jobs?queue=&state=&kind=&groupKey=&tag=&page=` | 列名(50页/页) |
| `GET /api/queues` | 命名后队列管理元a |
| `GET /api/groups` | 组元a( 货币、 暂停、 比率、 符号) |
| `GET /api/schedules` | Cron + 间隔时间表 |
| `POST /api/jobs/:id/cancel` | 待注销 |
| `POST /api/queues/:name/pause` 编号 : `:name/resume` |  |
| `POST /api/groups/:key/pause` 编号 : `:key/resume` |  |
| `POST /api/schedules/:name/enable` 编号 : `:name/disable` 编号 : `:name/remove` |  |

## 警卫

默认密码认证是故意简单的——这是一个 会话- cookie- gated 中间软件 . **用您已有的认证正面** 页:1 生产(用于检查您的 JWT, 入侵层 OIDC ) 代理、 IP 许可列表等)和 `auth.password` 选项成为 倒置后您可以离开未定义 .

## 所需资源

-   节点 20
-   `@eddyq/nestjs` 同一个小版本( pier dep)
-   `@eddyq/queue` 同一个小版本( pier dep)

## 许可证

麻省理工学院

## 常见问题

### @eddyq/wakeboard 是什么？

eddyq-wakeboard – Eddyq 的 Svelte 管理仪表板,可挂载为 NestJS 模块

### 如何安装 @eddyq/wakeboard？

在项目目录运行 npm install @eddyq/wakeboard，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nestjs/core（\>=10）、@nestjs/common（\>=10）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @eddyq/wakeboard 支持 TypeScript 吗？

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

### @eddyq/wakeboard 支持 ESM 还是 CommonJS？

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

### @eddyq/wakeboard 需要什么版本的 Node\.js？

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

### @eddyq/wakeboard 可以商用吗？

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

### @eddyq/wakeboard 的下载量有多少？

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

### @eddyq/wakeboard 还在维护吗？

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