mm_redis 1.9.8 → 1.9.9

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024, 邱文武
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -7,23 +7,23 @@ mm_redis是一个高效的Redis客户端封装库，提供了全面的Redis功
 
 ## 版本信息
 
-- **当前版本**: 1.9.6
-- **更新日期**: 2024-12-21
+- **当前版本**: 1.9.9
+- **更新日期**: 2024-12-22
 - **作者**: 邱文武
 - **NPM**: [https://www.npmjs.com/package/mm_redis](https://www.npmjs.com/package/mm_redis)
+- **GitHub**: [https://gitee.com/qiuwenwu91/mm_redis](https://gitee.com/qiuwenwu91/mm_redis)
 
 ## 功能特性
 
-- 完整的连接池管理，优化并发性能
-- 支持Pipeline批量操作，提升执行效率
-- 支持所有主要Redis数据类型：String、List、Hash、Set、Sorted Set等
-- 自动重连机制，使用指数退避策略
-- 全面的错误处理和日志记录
-- 自动JSON序列化/反序列化
-- 键前缀管理，支持多业务隔离
-- 自动连接管理，无需手动维护连接状态
-- 统一的事件系统，支持操作前后的事件监听
-- 支持数值增减操作
+- **完整的连接池管理**：优化并发性能，支持连接复用和自动回收
+- **Pipeline批量操作**：支持Redis Pipeline机制，大幅提升批量操作效率
+- **全面的数据类型支持**：覆盖String、List、Hash、Set、Sorted Set等所有主要Redis数据类型
+- **智能连接管理**：自动重连机制，使用指数退避策略，确保连接稳定可靠
+- **健壮的错误处理**：全面的错误处理机制和详细的日志记录，便于问题排查
+- **便捷的数据序列化**：自动JSON序列化/反序列化，无需手动转换数据格式
+- **键空间隔离**：支持键前缀管理，实现多业务场景下的数据隔离
+- **灵活的事件系统**：统一的事件机制，支持操作前后的事件监听和拦截
+- **丰富的数值操作**：支持原子性的数值增减操作，适用于计数器等场景
 
 ## 安装
 
@@ -31,6 +31,11 @@ mm_redis是一个高效的Redis客户端封装库，提供了全面的Redis功
 npm install mm_redis --save
 ```
 
+## Node.js版本要求
+
+- **最低支持版本**：Node.js 14.0.0
+- **推荐版本**：Node.js 16.0.0及以上
+
 ## 配置引入方式
 
 mm_redis支持多种配置引入方式：
@@ -74,6 +79,12 @@ redis.setConfig('./config.json');
 ```
 ## 变更日志
 
+### v1.9.8 (2024-12-22)
+- 更新文档，完善npm发布所需内容
+- 添加GitHub仓库链接到文档
+- 优化功能特性描述，增强文档可读性
+- 添加Node.js版本要求说明
+
 ### v1.9.5 (2024-12-21)
 - 修复hmset和hgetall方法的兼容性问题，确保与Redis客户端v5兼容
 - 移除已废弃的hexists、hkeys和hvals方法，优化API设计
@@ -122,20 +133,20 @@ await redis.close();
 
 ```javascript
 // 设置列表
-await redis.list_set('users', ['user1', 'user2', 'user3']);
+await redis.setForList('users', ['user1', 'user2', 'user3']);
 
 // 添加元素到列表
 await redis.list_push('users', 'user4');
 
 // 获取列表
-const users = await redis.list_get('users');
+const users = await redis.getForList('users');
 $.log.debug('[Redis] 用户列表:', users);
 
 // 获取列表的部分元素
-const partialUsers = await redis.list_get('users', 0, 2);
+const partialUsers = await redis.getForList('users', 0, 2);
 
 // 清空列表
-await redis.list_clear('users');
+await redis.clearForList('users');
 ```
 
 ### Hash操作
@@ -279,9 +290,9 @@ redis.on('set_error', (data) => {
 | addStr | addStr_before | addStr_after | addStr_error |
 | setrange | setrange_before | setrange_after | setrange_error |
 | clear | clear_before | clear_after | clear_error |
-| list_set | list_set_before | list_set_after | list_set_error |
+| setForList | setForList_before | setForList_after | setForList_error |
 | list_push | list_push_before | list_push_after | list_push_error |
-| list_clear | list_clear_before | list_clear_after | list_clear_error |
+| clearForList | clearForList_before | clearForList_after | clearForList_error |
 | mset | mset_before | mset_after | mset_error |
 | mget | mget_before | mget_after | mget_error |
 | hset | hset_before | hset_after | hset_error |
@@ -323,11 +334,11 @@ redis.on('set_error', (data) => {
 
 ### 列表操作
 
-- `list_set(key, value, seconds)`: 设置列表
+- `setForList(key, value, seconds)`: 设置列表
 - `list_push(key, value)`: 添加元素到列表
-- `list_get(key, start, end)`: 获取列表
-- `list_has(key, value)`: 判断列表中是否存在元素
-- `list_clear(key, value)`: 清空列表或重置列表
+- `getForList(key, start, end)`: 获取列表
+- `hasForList(key, value)`: 判断列表中是否存在元素
+- `clearForList(key, value)`: 清空列表或重置列表
 
 ### Hash操作
 
@@ -473,6 +484,34 @@ redis.on('set_error', (data) => {
 - 完善错误处理
 - 提升代码稳定性
 
-### 1.0.0
-- 初始版本发布
-- 基础Redis功能支持
+## 贡献指南
+
+我们欢迎社区贡献！如果你有兴趣为mm_redis项目做出贡献，请遵循以下步骤：
+
+1. Fork本仓库
+2. 创建你的功能分支 (`git checkout -b feature/amazing-feature`)
+3. 提交你的变更 (`git commit -m 'Add some amazing feature'`)
+4. 推送到分支 (`git push origin feature/amazing-feature`)
+5. 打开一个Pull Request
+
+请确保你的代码遵循项目的编码规范，并通过所有测试。
+
+## 许可证
+
+本项目采用ISC许可证 - 查看 [LICENSE](LICENSE) 文件了解详情
+
+## 问题反馈
+
+如果您在使用过程中遇到任何问题或有任何建议，请通过以下方式反馈：
+
+- **GitHub Issues**: [https://gitee.com/qiuwenwu91/mm_redis/issues](https://gitee.com/qiuwenwu91/mm_redis/issues)
+- **NPM**: [https://www.npmjs.com/package/mm_redis](https://www.npmjs.com/package/mm_redis)
+
+## 鸣谢
+
+感谢所有为本项目做出贡献的开发者和用户！
+
+## 相关链接
+
+- **Redis官方文档**: [https://redis.io/documentation](https://redis.io/documentation)
+- **Node Redis客户端**: [https://github.com/redis/node-redis](https://github.com/redis/node-redis)