# @efebia/queue 中文文档

规范地址：https://npmcn.com/package/%40efebia/queue/

版本：0\.0\.8
npm 元数据更新时间：2026-11-12T13:24:11.434Z
中文译文更新时间：2026-11-13T21:34:14.445Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：8.9 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2023-01-13T21:25:54.685Z
- 最新版本发布：2026-11-12T13:24:11.042Z
- 近 30 天下载量：3043（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 2 个）

## 中文简介

用于构建消息队列消费者的抽象基础类,并有内置的内置执行.

## 安装

```sh
npm install @efebia/queue
```

也可以使用：`pnpm add @efebia/queue`、`yarn add @efebia/queue`、`bun add @efebia/queue`

## README

# @efebia/队列

用于构建消息队列消费者的抽象基础类,并有内置的内置执行.

## 安装

```bash
npm install @efebia/queue
```

## 使用量

### 扩展 `Queue`

执行三种抽象方法连接任何队列后端:

```ts
import { Queue, QueueCallback, SentMessage } from '@efebia/queue';

type MyMessage = { userId: string; action: string };

class MyQueue extends Queue<RawSQSMessage, MyMessage> {
  async readMessages() {
    // fetch messages from your backend, return [] or undefined if none
    return await fetchFromBackend();
  }

  async processMessage(raw: RawSQSMessage, callback?: QueueCallback<MyMessage>) {
    const parsed = parse(raw);
    const state = { del: true };
    await callback?.(parsed.name, parsed.params, state);
    if (state.del) await deleteFromBackend(raw);
  }

  async sendMessage(body: SentMessage<MyMessage>) {
    await sendToBackend(JSON.stringify(body));
  }
}

const queue = new MyQueue({ sleepTimeout: 3000 });

// Start the polling loop
queue.start(async (name, params, state) => {
  console.log(name, params);
  // set state.del = false to prevent deletion
});
```

### 使用 `MemoryQueue`

用于测试或简单使用例的即用内置队列:

```ts
import { MemoryQueue } from '@efebia/queue';

type Job = { task: string };

const queue = new MemoryQueue<Job>({});

// Send a message
await queue.send({ name: 'doWork', params: { task: 'hello' } });

// Start consuming
queue.start(async (name, params, state) => {
  console.log(`Processing ${name}:`, params);
});

// Stop the loop
queue.stop();
```

## API 密码

### `Queue<TReceivedMessage, TMessage>` (摘要)

**构造选项( E)`QueueOptions`:**

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `sleepTimeout` | `number` | `5000` | 重试前等待出错的毫秒 |
| `errorCallback` | `(error) => void` | `console.error` | 在投票循环中出现未发现的错误 |

**执行摘要方法:**

| 方法 | 说明 |
| --- | --- |
| `readMessages()` | 获取下一批信件 。 返回时 `undefined` 以跳过当前迭代. |
| `processMessage(message, callback?)` | 处理单个消息并引用回调 . |
| `sendMessage(body)` | 向后面的队列后端发送信息 . |

**方法:**

-   `start(callback, canThrow?)` 开始无限的投票循环
-   `stop()` —— 指示当前迭代后要退出的循环
-   `resume(callback)` ——重新启动已停止的队列
-   `isRunning()` ——返回 `true` 如果循环活动
-   `send(message)` ——发送信息,自动添加 `createdAt` 改为参数

**回调签名 :**

```ts
(name: string, params: TMessage, state: { del: boolean }) => void | Promise<void>
```

设定 `state.del = false` 在回调中防止处理后信件被删除.

### `MemoryQueue<TMessage>`

扩展 `Queue` 带有内存信件阵列。 可用于测试和地方发展.

### 类型

-   `Message<TParams>` —— 说 `{ name: string; params: TParams }`
-   `SentMessage<TParams>` —— 说 `Message` 与 `params.createdAt: Date` 已添加

## 许可证

麻省理工学院

## 常见问题

### @efebia/queue 是什么？

用于构建消息队列消费者的抽象基础类,并有内置的内置执行\.

### 如何安装 @efebia/queue？

在项目目录运行 npm install @efebia/queue，或使用 pnpm add / yarn add / bun add。

### @efebia/queue 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/efebia\_\_queue 是否存在。

### @efebia/queue 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @efebia/queue 可以商用吗？

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

### @efebia/queue 的下载量有多少？

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

### @efebia/queue 还在维护吗？

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