@hile/ioredis 1.1.2 → 2.0.0

package/dist/index.d.ts

@@ -1,13 +1,19 @@
-import Redis from 'ioredis';
+import Redis, { RedisOptions } from 'ioredis';
+export type { RedisOptions } from 'ioredis';
 /**
- * 创建 Redis 服务
- * 数据从环境变量中获取
+ * 创建 Redis 客户端（手动模式）
+ * @param options Redis 连接选项，不传则从环境变量读取
+ * @returns 等待连接就绪后的 Redis 实例
+ */
+export declare function createRedis(options?: RedisOptions): Promise<Redis>;
+/**
+ * Redis 服务（容器模式）
  * 环境变量：
- * - REDIS_HOST: Redis 主机
- * - REDIS_PORT: Redis 端口
- * - REDIS_USERNAME: Redis 用户名
- * - REDIS_PASSWORD: Redis 密码
- * - REDIS_DB: Redis 数据库
+ * - REDIS_HOST
+ * - REDIS_PORT
+ * - REDIS_USERNAME
+ * - REDIS_PASSWORD
+ * - REDIS_DB
  */
 declare const _default: import("@hile/core").ServiceRegisterProps<Redis>;
 export default _default;

package/dist/index.js

@@ -2,24 +2,24 @@ import pkg from '../package.json' with { type: 'json' };
 import { defineService } from '@hile/core';
 import Redis from 'ioredis';
 /**
- * 创建 Redis 服务
- * 数据从环境变量中获取
- * 环境变量：
- * - REDIS_HOST: Redis 主机
- * - REDIS_PORT: Redis 端口
- * - REDIS_USERNAME: Redis 用户名
- * - REDIS_PASSWORD: Redis 密码
- * - REDIS_DB: Redis 数据库
+ * 从环境变量读取 Redis 配置
  */
-export default defineService(Symbol.for(pkg.name), async (shutdown) => {
-    const options = {
+function envOptions() {
+    return {
         host: process.env.REDIS_HOST,
         port: typeof process.env.REDIS_PORT === 'string' ? Number(process.env.REDIS_PORT) : process.env.REDIS_PORT,
         username: process.env.REDIS_USERNAME,
         password: process.env.REDIS_PASSWORD,
         db: typeof process.env.REDIS_DB === 'string' ? Number(process.env.REDIS_DB) : process.env.REDIS_DB || 0,
     };
-    const client = new Redis(options);
+}
+/**
+ * 创建 Redis 客户端（手动模式）
+ * @param options Redis 连接选项，不传则从环境变量读取
+ * @returns 等待连接就绪后的 Redis 实例
+ */
+export async function createRedis(options) {
+    const client = new Redis(options ?? envOptions());
     await new Promise((resolve, reject) => {
         const onerror = (e) => reject(e);
         client.on('error', onerror);
@@ -28,6 +28,19 @@ export default defineService(Symbol.for(pkg.name), async (shutdown) => {
             resolve();
         });
     });
+    return client;
+}
+/**
+ * Redis 服务（容器模式）
+ * 环境变量：
+ * - REDIS_HOST
+ * - REDIS_PORT
+ * - REDIS_USERNAME
+ * - REDIS_PASSWORD
+ * - REDIS_DB
+ */
+export default defineService(Symbol.for(pkg.name), async (shutdown) => {
+    const client = await createRedis();
     shutdown(() => client.disconnect());
     return client;
 });

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@hile/ioredis",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "type": "module",
   "main": "./dist/index.js",
   "scripts": {
     "build": "tsc -b && fix-esm-import-path --preserve-import-type ./dist",
-    "dev": "tsc -b --watch"
+    "dev": "tsc -b --watch",
+    "test": "vitest run"
   },
   "files": [
     "dist",
-    "README.md",
-    "SKILL.md"
+    "README.md"
   ],
   "license": "MIT",
   "publishConfig": {
@@ -21,8 +21,8 @@
     "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@hile/core": "^1.1.2",
+    "@hile/core": "^2.0.0",
     "ioredis": "^5.10.0"
   },
-  "gitHead": "439a7eb90a233d466f97df932782d74dd64a50f2"
+  "gitHead": "8e0fd1f78b5a8abd21218d1f596ada2533a0c8e7"
 }

package/SKILL.md

@@ -1,54 +0,0 @@
----
-name: hile-ioredis
-description: "@hile/ioredis 的代码生成与使用规范。适用于 Redis 服务加载、环境变量配置、及与 @hile/core/@hile/cli 集成场景。"
----
-
-# @hile/ioredis SKILL
-
-本文档规范 `@hile/ioredis` 的使用方式，确保 Redis 客户端生命周期由 Hile 统一管理。
-
-## 1. 架构概览
-
-`@hile/ioredis` 提供一个默认导出的 Hile 服务（服务 key 为稳定 symbol，见包内实现）：
-
-- 使用环境变量构建 ioredis 客户端
-- 首次加载时建立连接并等待 `connect`
-- 进程退出时调用 `client.disconnect()`
-
-依赖：`@hile/core`、`ioredis`。
-
-## 2. 环境变量
-
-| 变量 | 说明 |
-|---|---|
-| `REDIS_HOST` | Redis 主机 |
-| `REDIS_PORT` | Redis 端口（字符串转数字） |
-| `REDIS_USERNAME` | Redis 用户名 |
-| `REDIS_PASSWORD` | Redis 密码 |
-| `REDIS_DB` | Redis 数据库编号（默认 `0`） |
-
-## 3. 标准模板
-
-### 3.1 加载默认服务
-
-```typescript
-import { loadService } from '@hile/core'
-import ioredisService from '@hile/ioredis'
-
-const redis = await loadService(ioredisService)
-await redis.set('key', 'value')
-const value = await redis.get('key')
-```
-
-## 4. 强制规则
-
-1. 统一通过 `loadService(ioredisService)` 获取 Redis 客户端。
-2. 不要再额外封装一个同用途的全局 Redis 单例与本包混用。
-3. 生产环境应通过 `REDIS_*` 变量配置，避免硬编码。
-4. 依赖 Redis 的服务应在服务函数内部加载，不在模块顶层缓存实例。
-
-## 5. API 速查
-
-| 导出 | 说明 |
-|---|---|
-| 默认导出 | Hile 服务化 Redis 客户端 |