@eturino/ioredis-del-by-pattern

中文文档
3.0.1发布于 2025/01/22MITTypeScriptESM + CJS零依赖近 30 天下载 6400

ioredis util 可以在 redis 上通过模式删除密钥 。 支持批次( 管道) , 让用户决定使用 del 或者说 unlink 方法。 。 .

中文使用文档
文档目录8 节
  1. 安装
  2. 使用量
  3. 鸣谢
  4. 开发、提交、版本和出版
  5. 提交和更改
  6. 创建第一个版本
  7. 发布文件
  8. 生成一个版本

@eturino/ioredis-del-by-pattern

npm version Build Status Maintainability Test Coverage

类型 Doc 在此生成文件

Github 重播这里

雄风 用于在 redis 上以图案删除密钥 。 支持批次( 管道) , 让用户决定使用 del 或者说 unlink 方法。 。 .

用一个 scanStream 在ioredis中收集匹配的密钥以删除.

安装

yarn add @eturino/ioredis-del-by-pattern 或者说 npm install @eturino/ioredis-del-by-pattern。 。 。 .

使用量

导出函数 redisDelByPattern() 返回带有全部被删除的密钥数的保证,使用给定的图案并重新显示客户端.

import { redisDelByPattern } from "@eturino/ioredis-del-by-pattern";

const deletedKeysCount: number = await redisDelByPattern({
  pattern: "delete-with-this-prefix-*",
  redis // ioredis client
});

它支持以下段落:

  • redis: redis 客户端. (动静)
  • pattern:在再磁盘扫描流中匹配. (动静)
  • deletionMethod: 决定使用 DEL 或者说 UNLINK 命令(默认取消链接).
  • withPipeline: 决定使用管道执行命令或在每个流事件上执行命令(默认没有管道).
  • pipelineBatchLimit: 100 默认,如果 withPipeline 这是真的.
  • enableLog: 如果为真, 将使用指定的对数Fn 记录动作 .
  • logFn: 用于日志事件的函数。 默认为( console.log).
  • logWarnFn: 要将事件日志为 warn默认为( console.warn).
  • logPrefix: 对数Fn的前缀(默认为) "[REDIS-DEL-BY-PATTERN] ") (中文(简体) ).
import { redisDelByPattern } from "@eturino/ioredis-del-by-pattern";

const deletedKeysCount: number = await redisDelByPattern({
  pattern: `${prefix}-delete-me*`,
  redis, // ioredis client
  withPipeline: true,
  deletionMethod: RedisDeletionMethod.unlink
});

鸣谢

分批执行的职能主要基于本条 “在 Redis 中查找并删除多个匹配的密钥 : 向右转 " (中文(简体) ) 以 安基特·贾因

开发、提交、版本和出版

见文件促进发展

见 Typescript-Starter 文档。 。 。 .

提交和更改

对于犯罪,你应该使用 commitizen

yarn global add commitizen

#commit your changes:
git cz

作为打字符启动文件的表示 :

此项目是用于 常规更改日志 使管理释放更容易。 见 标准版本 关于工作流程的更多信息的文件,或 CHANGELOG.md 举个例子.

# bump package.json version, update CHANGELOG.md, git tag the release
yarn run version

你可以找到一个工具,比如 wip 在你准备好做出有意义的承诺之前 帮助管理正在进行的工作.

创建第一个版本

一旦您准备好创建第一个版本,请运行如下(注意: reset 具有破坏性,并将从目录中删除所有不在 git repo 中的文件.

# Reset the repo to the latest commit and build everything
yarn run reset && yarn run test && yarn run doc:html

# Then version it with standard-version options. e.g.:
# don't bump package.json version
yarn run version -- --first-release

# Other popular options include:

# PGP sign it:
# $ yarn run version -- --sign

# alpha release:
# $ yarn run version -- --prerelease alpha

之后,记住 发布文件。 。 。 .

并最终将新标签推向github并发布到npm.

# Push to git
git push --follow-tags origin master

# Publish to NPM (allowing public access, required if the package name is namespaced like `@somewhere/some-lib`)
yarn publish --access public

发布文件

yarn run doc:html && yarn run doc:publish

这将生成文件并在 github 页面中发布 .

生成一个版本

准备新版有一个单一的线条命令. 见 一步一步以 TypeScript- Startter 发布准备脚本

# Prepare a standard release
yarn prepare-release

# Push to git
git push --follow-tags origin master

# Publish to NPM (allowing public access, required if the package name is namespaced like `@somewhere/some-lib`)
yarn publish --access public

版本与发布记录

@eturino/ioredis-del-by-pattern 共发布 10 个版本,首次发布于 2020/02/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.1latest2025/01/221.8 年前
3.0.02025/01/221.8 年前
2.0.12023/05/313 年前
2.0.02023/02/033 年前
1.1.02021/09/145 年前
1.0.42021/01/265 年前

关于 @eturino/ioredis-del-by-pattern 的常见问题

@eturino/ioredis-del-by-pattern 是什么?

ioredis util 可以在 redis 上通过模式删除密钥 。 支持批次( 管道) , 让用户决定使用 del 或者说 unlink 方法。 。 .

如何安装 @eturino/ioredis-del-by-pattern?

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

@eturino/ioredis-del-by-pattern 支持 TypeScript 吗?

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

@eturino/ioredis-del-by-pattern 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@eturino/ioredis-del-by-pattern 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@eturino/ioredis-del-by-pattern 可以商用吗?

@eturino/ioredis-del-by-pattern 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@eturino/ioredis-del-by-pattern 的下载量有多少?

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

@eturino/ioredis-del-by-pattern 还在维护吗?

最新版本 3.0.1 发布于 2025/01/22(1.8 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/02/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。