@elysiumjs/redis

中文文档
0.2.1发布于 2026/11/13Apache-2.0TypeScriptES Module近 30 天下载 3423

Elysium.js框架的 Redis后端:连接,缓存,速率限制,锁,Heracles队列和工人,流程和会话存储.

中文使用文档
文档目录9 节
  1. 安装
  2. 连接
  3. 锁定
  4. 快取存储
  5. 费率限额
  6. 赫拉克勒斯语Name
  7. 流量
  8. 会议
  9. 许可证

@elysiumjs/ redis (英语)

重写为 极乐世界:连接,锁驱动,缓存商店,速率限制,Heracles与工人的运输,以及流量和会话商店.

安装

bun add @elysiumjs/olympus @elysiumjs/redis

连接

RedisModule 将每个连接登记为全球服务 redis.connection.{name}。客户端是先使用的.

import { runtime as bunRuntime } from '@elysiumjs/bun';
import { Application } from '@elysiumjs/olympus';
import { Redis, RedisModule } from '@elysiumjs/redis';

@Application.register({
    runtime: bunRuntime,
    modules: [
        RedisModule.with({
            default: 'cache',
            connections: { cache: { url: process.env.REDIS_URL! } }
        })
    ]
})
class App extends Application {}

const client = Redis.getConnection('cache');

默认客户端是 Bun.RedisClient。通过 client 在模块配置中使用另一个: ioredis(...) 包裹一个 ioredis 客户端,并且 upstash({ token }) 与Upstash就HTTP进行会谈,HTTP也致力于Cloudflare工人.

锁定

导入软件包注册 redis 驱动程序 Lock 端口 。 锁是一个密钥集 SET NX PX; Lua 脚本发布并仅为持有者扩展.

import { Lock } from '@elysiumjs/olympus';
import { HeraclesModule } from '@elysiumjs/olympus/heracles';

import '@elysiumjs/redis';

HeraclesModule.with({ lock: Lock.for('redis', { connection: 'cache', prefix: 'lock:' }) });

快取存储

KeyvRedis 是一个连接上的 Keyv 商店,用于缓存 @elysiumjs/olympus/mnemosyne数字 :

import { MnemosyneModule } from '@elysiumjs/olympus/mnemosyne';
import { KeyvRedis } from '@elysiumjs/redis';

MnemosyneModule.with({
    cache: { stores: { redis: () => new KeyvRedis({ connection: 'cache' }) } }
});
// Cache.store('redis')

费率限额

RedisRateLimitStore 保留计数器 RateLimit 在Redis, 所以每个实例的应用分享.

赫拉克勒斯语Name

RedisTransport 包含在 Redis 流上的队列任务. HeraclesRedisModule 添加两个命令: heracles:work 经营一个消耗排队量的工人 heracles:clean 从溪流中删除已完成的工作.

import { HeraclesModule } from '@elysiumjs/olympus/heracles';
import { HeraclesRedisModule, RedisTransport } from '@elysiumjs/redis';

@Application.register({
    modules: [
        RedisModule.with({ connections: { default: { url: process.env.REDIS_URL! } } }),
        HeraclesModule.with({ queues: { emails: { transport: RedisTransport } } }),
        HeraclesRedisModule
    ]
})
class App extends Application {}
styx heracles:work --id worker-1 --queues emails --redis default

流量

RedisFlowStore 保持流动 @elysiumjs/olympus/ariadne数字 :

import { AriadneModule } from '@elysiumjs/olympus/ariadne';
import { Redis, RedisFlowStore } from '@elysiumjs/redis';

AriadneModule.with({
    store: new RedisFlowStore({ connection: () => Redis.getConnection(), prefix: 'flow:' })
});

每道流都是散列 {prefix}{flow:flowKey},其租赁密钥将自行失效,一旦流量完成,则该标记将保持其所有者和TTL的结束时间。 流键共享散列标记,所以它们生活在同一个集群槽上.

会议

RedisSessionStore 保存会议 @elysiumjs/olympus/themis在任何连接上,上层包括:

import { ThemisModule } from '@elysiumjs/olympus/themis';
import { Redis, RedisSessionStore } from '@elysiumjs/redis';

ThemisModule.with({
    secret: env.APP_SECRET,
    session: {
        store: new RedisSessionStore({ connection: () => Redis.getConnection(), prefix: 'session:' })
    }
});

每个会话都是 JSON 值 {prefix}{id} (单位:千美元)session: 页:1.

许可证

阿帕奇 - 2.0

版本与发布记录

@elysiumjs/redis 共发布 17 个版本,首次发布于 2026/11/07;过去 12 个月发布了 17 个版本。

版本发布日期距今
0.2.1latest2026/11/13今天
0.2.02026/11/13今天
0.1.132026/11/121 天前
0.1.122026/11/112 天前
0.1.112026/11/112 天前
0.1.102026/11/112 天前

关于 @elysiumjs/redis 的常见问题

@elysiumjs/redis 是什么?

Elysium.js框架的 Redis后端:连接,缓存,速率限制,锁,Heracles队列和工人,流程和会话存储.

如何安装 @elysiumjs/redis?

在项目目录运行 npm install @elysiumjs/redis,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@elysiumjs/olympus(^0.26.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@elysiumjs/redis 支持 TypeScript 吗?

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

@elysiumjs/redis 支持 ESM 还是 CommonJS?

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

@elysiumjs/redis 可以商用吗?

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

@elysiumjs/redis 的下载量有多少?

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

@elysiumjs/redis 还在维护吗?

最新版本 0.2.1 发布于 2026/11/13(今天);至今共发布 17 个版本,其中过去 12 个月发布了 17 个;首次发布于 2026/11/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。