# @antelopejs/interface-redis 中文文档

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

版本：0\.0\.9
npm 元数据更新时间：2026-10-17T07:19:36.460Z
中文译文更新时间：2026-11-06T06:26:45.209Z
软件包许可：Apache-2\.0

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

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

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

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

## 中文简介

直接访问共享 Redis 客户端的羚羊JS 接口

## 安装

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

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

## README

# @antelopejs/interface-resdis (英语)

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

直接访问一个藏羚羊JS项目的Redis客户端:一个共享连接,用于缓存,柜台,酒吧/分站以及任何其他Redis命令.

## 它提供的东西

-   `GetClient()` 解决项目共享问题 [雄风](https://github.com/redis/ioredis) 客户端一旦连接打开.
-   客户端揭露出每个Redis的指令,交易和管道.
-   每个模块都会重用执行模块打开并配置的一个连接.

## 执行情况

| 模块 | 页:1 |
| --- | --- |
| [`@antelopejs/redis`](https://github.com/AntelopeJS/redis) | 还执行 `@antelopejs/interface-redis-scheduler` |

## 安装

将接口添加到对 Redis 的模块:

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

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

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

## 快开始

```ts
import { GetClient } from "@antelopejs/interface-redis";

const CACHE_TTL_SECONDS = 60;

export async function cachePage(path: string, html: string) {
  const client = await GetClient();
  await client.set(`page:${path}`, html, "EX", CACHE_TTL_SECONDS);
}

export async function readCachedPage(path: string) {
  const client = await GetClient();
  return await client.get(`page:${path}`);
}
```

## 文档

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

## 兼容性

需要藏羚羊JS核心 `1.x` 和以下同伴依赖关系:

| 软件包 | 范围 |
| --- | --- |
| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` |

驱动依赖 :

| 软件包 | 范围 |
| --- | --- |
| `ioredis` | `^5.10.1` |

## 捐款

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

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

## 许可证

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

## 常见问题

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

直接访问共享 Redis 客户端的羚羊JS 接口

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

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

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

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

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

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

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

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

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

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

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

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