# @antelopejs/interface-redis-scheduler 中文文档

规范地址：https://npmcn.com/package/%40antelopejs/interface-redis-scheduler/

版本：0\.0\.10
npm 元数据更新时间：2026-11-04T16:47:30.448Z
中文译文更新时间：2026-11-06T15:50:41.521Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40antelopejs/interface-redis-scheduler
原文对照：https://npmcn.com/package/%40antelopejs/interface-redis-scheduler/?lang=original
项目主页：https://interfaces.antelopejs.com/docs/redis-scheduler
源码仓库：https://github.com/AntelopeJS/interface-redis-scheduler

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

- 包体积（解压后）：79.1 kB，17 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@antelopejs/interface-core \>=0\.2\.4 \<1\.0\.0，@antelopejs/interface-redis \>=0\.0\.9 \<1\.0\.0
- 首次发布：2026-03-22T17:11:09.588Z
- 最新版本发布：2026-11-04T16:47:30.064Z
- 近 30 天下载量：2832（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

用于在 Redis 上调度任务的羚羊JS 接口, 失败时重试

## 安装

```sh
npm install @antelopejs/interface-redis-scheduler
```

也可以使用：`pnpm add @antelopejs/interface-redis-scheduler`、`yarn add @antelopejs/interface-redis-scheduler`、`bun add @antelopejs/interface-redis-scheduler`

## README

# `@antelopejs/interface-redis-scheduler`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-redis-scheduler?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-redis-scheduler) [![License](https://img.shields.io/npm/l/@antelopejs/interface-redis-scheduler?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-redis-scheduler/LICENSE) [![Discord](https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000)](https://discord.gg/g4pFt6eXqu) [![Docs](https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000)](https://interfaces.antelopejs.com/docs/redis-scheduler)

用于羚羊JS的 Redis 任务调度 。 您为特定时间安排任务, 当任务到期时, 应用程序中的收听者会运行任务, 失败时最多重复三次 .

## 它提供的东西

-   `setHandler` 注册运行一种任务的函数.
-   `addTask` 在毫秒内为 Unix 时间戳安排任务. `removeTask` 运行前删除已排队的条目.
-   `enableListener` 开始任务处理. `disableListener` 只关闭通知订阅者,而不关闭待决定时器.
-   任务生活在一个Redis排序的集中,因此它们在应用程序重新启动后存活下来,应用程序的每一个实例都看到相同的队列. 每个应尽的任务都交给一个听众.

## 执行情况

| 模块 | 页:1 |
| --- | --- |
| [`@antelopejs/redis`](https://github.com/AntelopeJS/redis) | 还执行 `@antelopejs/interface-redis`,用于提供调度器使用的 Redis 客户端 |

## 安装

将界面添加到调度任务的模块中:

```bash
pnpm add @antelopejs/interface-redis-scheduler
```

然后在项目中添加执行内容:

```bash
ajs project modules add @antelopejs/redis
```

## 快开始

```ts
import { Logging } from "@antelopejs/interface-core/logging";
import {
  addTask,
  disableListener,
  enableListener,
  setHandler,
} from "@antelopejs/interface-redis-scheduler";

const ONE_HOUR_MS = 60 * 60 * 1000;

setHandler("overdue-notice", async (taskInfo) => {
  const { memberId } = JSON.parse(taskInfo);
  Logging.Info(`Remind member ${memberId}`);
});

export async function start() {
  await enableListener();
  await addTask(
    "overdue-notice",
    Date.now() + ONE_HOUR_MS,
    JSON.stringify({ memberId: "M-1042" }),
  );
}

export async function stop() {
  await disableListener();
}
```

在您为它安排任务之前注册一个处理器 . `addTask` 拒绝此进程尚未注册的处理器名称 .

`disableListener()` 不是完全关闭或暂停。 待定的计时器和运行中的处理器可以继续处理任务. 读取 [寿命周期和交货限制](https://npmcn.com/package/%40antelopejs/interface-redis-scheduler/docs/1.introduction.md#disablelistener) 在你用它关闭之前.

## 文档

-   [导言和时间表参考](https://npmcn.com/package/%40antelopejs/interface-redis-scheduler/docs/1.introduction.md)

## 兼容性

模块宣布这些对等关系:

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.2.4` |
| `@antelopejs/interface-redis` | `>=0.0.9 <1.0.0` | `0.0.9` |

## 捐款

读取 [捐款额](https://npmcn.com/package/%40antelopejs/interface-redis-scheduler/CONTRIBUTING.md) 在你打开拉动请求之前。 当地检查为:

```bash
pnpm install
pnpm lint
pnpm test
```

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40antelopejs/interface-redis-scheduler/LICENSE)

## 常见问题

### @antelopejs/interface-redis-scheduler 是什么？

用于在 Redis 上调度任务的羚羊JS 接口, 失败时重试

### 如何安装 @antelopejs/interface-redis-scheduler？

在项目目录运行 npm install @antelopejs/interface-redis-scheduler，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@antelopejs/interface-core（\>=0\.2\.4 \<1\.0\.0）、@antelopejs/interface-redis（\>=0\.0\.9 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @antelopejs/interface-redis-scheduler 支持 TypeScript 吗？

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

### @antelopejs/interface-redis-scheduler 支持 ESM 还是 CommonJS？

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

### @antelopejs/interface-redis-scheduler 可以商用吗？

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

### @antelopejs/interface-redis-scheduler 的下载量有多少？

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

### @antelopejs/interface-redis-scheduler 还在维护吗？

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